Daptin server API documentation version v1
http://
Actions defined over Cloud store
Actions defined over Cloud store
upload_file
upload_file
post /action/cloud_store/upload_file
Actions defined over Marketplace
Actions defined over Marketplace
install_marketplace_package
install_marketplace_package
post /action/marketplace/install_marketplace_package
publish_package_to_market
publish_package_to_market
refresh_marketplace_packages
refresh_marketplace_packages
visit_marketplace_github
visit_marketplace_github
Actions defined over Oauth connect
Actions defined over Oauth connect
oauth.login.begin
oauth.login.begin
Actions defined over Package
Actions defined over Package
buy_package
buy_package
Actions defined over User
Actions defined over User
signin
signin
signup
signup
post /action/user/signup
signup
Body
Media type: application/json
Type: object
Properties- email: (string)
- name: (string)
- password: (string)
- passwordConfirm: (string)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- confirmed: required (string)
- delay: required (string)
- email: required (string)
- location: required (string)
- message: required (string)
- name: required (string)
- password: required (string)
- title: required (string)
- type: required (string)
- user_id: required (string)
- usergroup_id: required (string)
- window: required (string)
Actions defined over World
Actions defined over World
add_exchange
add_exchange
post /action/world/add_exchange
add_exchange
Body
Media type: application/json
Type: object
Properties- app_key: (string)
- name: (string)
- sheet_id: (string)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- attributes: required (string)
- name: required (string)
- options: required (string)
- source_attributes: required (string)
- source_type: required (string)
- target_attributes: required (string)
- target_type: required (string)
become_an_administrator
become_an_administrator
download_system_schema
download_system_schema
export_data
export_data
generate_random_data
generate_random_data
post /action/world/generate_random_data
generate_random_data
Body
Media type: application/json
Type: object
Properties- count: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- count: required (string)
- table_name: required (string)
- user_id: required (string)
- user_reference_id: required (string)
import_data
import_data
post /action/world/import_data
import_data
Body
Media type: application/json
Type: object
Properties- dump_file: (string)
- truncate_before_insert: (boolean)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- dump_file: required (string)
- execute_middleware_chain: required (string)
- table_name: required (string)
- truncate_before_insert: required (string)
- user: required (string)
- world_reference_id: required (string)
restart_daptin
restart_daptin
upload_csv_to_system_schema
upload_csv_to_system_schema
post /action/world/upload_csv_to_system_schema
upload_csv_to_system_schema
Body
Media type: application/json
Type: object
Properties- add_missing_columns: (boolean)
- create_if_not_exists: (boolean)
- data_csv_file: (string)
- entity_name: (string)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- add_missing_columns: required (string)
- create_if_not_exists: required (string)
- data_csv_file: required (string)
- entity_name: required (string)
upload_system_schema
upload_system_schema
upload_xls_to_system_schema
upload_xls_to_system_schema
post /action/world/upload_xls_to_system_schema
upload_xls_to_system_schema
Body
Media type: application/json
Type: object
Properties- add_missing_columns: (boolean)
- create_if_not_exists: (boolean)
- data_xls_file: (string)
- entity_name: (string)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- add_missing_columns: required (string)
- create_if_not_exists: required (string)
- data_xls_file: required (string)
- entity_name: required (string)
action
Resources in this group are related to action
Returns a list of Action
Create a new action
get /api/action
Returns a list of Action
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- action_name: (string)
- action_schema: (string)
- created_at: (datetime)
- instance_optional: (boolean)
- label: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/action
Create a new action
Body
Media type: application/json
Type: object
Properties- action_name: (string)
- action_schema: (string)
- created_at: (datetime)
- instance_optional: (boolean)
- label: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- action_name: (string)
- action_schema: (string)
- created_at: (datetime)
- instance_optional: (boolean)
- label: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a action
Get action by id
Edit an existing action
get /api/action/{referenceId}
Get action by id
URI Parameters
- referenceId: required (string)
Reference id of the action to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- action_name: (string)
- action_schema: (string)
- created_at: (datetime)
- instance_optional: (boolean)
- label: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/action/{referenceId}
Edit an existing action
URI Parameters
- referenceId: required (string)
Reference id of the action to be fetched
Body
Media type: application/json
Type: object
Properties- action_name: (string)
- action_schema: (string)
- created_at: (datetime)
- instance_optional: (boolean)
- label: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- action_name: (string)
- action_schema: (string)
- created_at: (datetime)
- instance_optional: (boolean)
- label: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/action/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the action to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
get /api/action/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the action to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related world from the parent object
Returns a list of World
get /api/action/{referenceId}/world
Returns a list of World
URI Parameters
- referenceId: required (string)
Reference id of the action to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- default_order: required (number)
- default_permission: (number)
- icon: required (string)
- is_hidden: (boolean)
- is_join_table: (boolean)
- is_state_tracking_enabled: (boolean)
- is_top_level: (boolean)
- reference_id: (string)
- table_name: (string)
- updated_at: required (datetime)
- version: (number)
- world_schema_json: (string)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_column_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
cloud_store
Resources in this group are related to cloud_store
Returns a list of Cloud store
Create a new cloud_store
get /api/cloud_store
Returns a list of Cloud store
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- root_path: (string)
- store_parameters: (string)
- store_provider: (string)
- store_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/cloud_store
Create a new cloud_store
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- name: (string)
- reference_id: (string)
- root_path: (string)
- store_parameters: (string)
- store_provider: (string)
- store_type: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- root_path: (string)
- store_parameters: (string)
- store_provider: (string)
- store_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a cloud_store
Get cloud_store by id
Edit an existing cloud_store
get /api/cloud_store/{referenceId}
Get cloud_store by id
URI Parameters
- referenceId: required (string)
Reference id of the cloud_store to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- root_path: (string)
- store_parameters: (string)
- store_provider: (string)
- store_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/cloud_store/{referenceId}
Edit an existing cloud_store
URI Parameters
- referenceId: required (string)
Reference id of the cloud_store to be fetched
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- name: (string)
- reference_id: (string)
- root_path: (string)
- store_parameters: (string)
- store_provider: (string)
- store_type: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- root_path: (string)
- store_parameters: (string)
- store_provider: (string)
- store_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related oauth_token from the parent object
Returns a list of Oauth token
delete /api/cloud_store/{referenceId}/oauth_token
get /api/cloud_store/{referenceId}/oauth_token
Returns a list of Oauth token
URI Parameters
- referenceId: required (string)
Reference id of the cloud_store to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- access_token: (string)
- created_at: (datetime)
- expires_in: (number)
- reference_id: (string)
- refresh_token: (string)
- token_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related site from the parent object
Returns a list of Site
get /api/cloud_store/{referenceId}/site
Returns a list of Site
URI Parameters
- referenceId: required (string)
Reference id of the cloud_store to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- hostname: (string)
- name: (string)
- path: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/cloud_store/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the cloud_store to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
delete /api/cloud_store/{referenceId}/usergroup
get /api/cloud_store/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the cloud_store to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
data_exchange
Resources in this group are related to data_exchange
Returns a list of Data exchange
Create a new data_exchange
get /api/data_exchange
Returns a list of Data exchange
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- attributes: (string)
- created_at: (datetime)
- name: (string)
- options: (string)
- reference_id: (string)
- source_attributes: (string)
- source_type: (string)
- target_attributes: (string)
- target_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/data_exchange
Create a new data_exchange
Body
Media type: application/json
Type: object
Properties- attributes: (string)
- created_at: (datetime)
- name: (string)
- options: (string)
- reference_id: (string)
- source_attributes: (string)
- source_type: (string)
- target_attributes: (string)
- target_type: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- attributes: (string)
- created_at: (datetime)
- name: (string)
- options: (string)
- reference_id: (string)
- source_attributes: (string)
- source_type: (string)
- target_attributes: (string)
- target_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a data_exchange
Get data_exchange by id
Edit an existing data_exchange
get /api/data_exchange/{referenceId}
Get data_exchange by id
URI Parameters
- referenceId: required (string)
Reference id of the data_exchange to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- attributes: (string)
- created_at: (datetime)
- name: (string)
- options: (string)
- reference_id: (string)
- source_attributes: (string)
- source_type: (string)
- target_attributes: (string)
- target_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/data_exchange/{referenceId}
Edit an existing data_exchange
URI Parameters
- referenceId: required (string)
Reference id of the data_exchange to be fetched
Body
Media type: application/json
Type: object
Properties- attributes: (string)
- created_at: (datetime)
- name: (string)
- options: (string)
- reference_id: (string)
- source_attributes: (string)
- source_type: (string)
- target_attributes: (string)
- target_type: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- attributes: (string)
- created_at: (datetime)
- name: (string)
- options: (string)
- reference_id: (string)
- source_attributes: (string)
- source_type: (string)
- target_attributes: (string)
- target_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related oauth_token from the parent object
Returns a list of Oauth token
delete /api/data_exchange/{referenceId}/oauth_token
get /api/data_exchange/{referenceId}/oauth_token
Returns a list of Oauth token
URI Parameters
- referenceId: required (string)
Reference id of the data_exchange to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- access_token: (string)
- created_at: (datetime)
- expires_in: (number)
- reference_id: (string)
- refresh_token: (string)
- token_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
delete /api/data_exchange/{referenceId}/user
get /api/data_exchange/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the data_exchange to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
delete /api/data_exchange/{referenceId}/usergroup
get /api/data_exchange/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the data_exchange to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
dev1
Resources in this group are related to dev1
Returns a list of Dev1
Create a new dev1
get /api/dev1
Returns a list of Dev1
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/dev1
Create a new dev1
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a dev1
Get dev1 by id
Edit an existing dev1
get /api/dev1/{referenceId}
Get dev1 by id
URI Parameters
- referenceId: required (string)
Reference id of the dev1 to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/dev1/{referenceId}
Edit an existing dev1
URI Parameters
- referenceId: required (string)
Reference id of the dev1 to be fetched
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/dev1/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the dev1 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
get /api/dev1/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the dev1 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
device1
Resources in this group are related to device1
Returns a list of Device1
Create a new device1
get /api/device1
Returns a list of Device1
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (string)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/device1
Create a new device1
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- device_name: (string)
- landscape_width: (string)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (string)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a device1
Get device1 by id
Edit an existing device1
get /api/device1/{referenceId}
Get device1 by id
URI Parameters
- referenceId: required (string)
Reference id of the device1 to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (string)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/device1/{referenceId}
Edit an existing device1
URI Parameters
- referenceId: required (string)
Reference id of the device1 to be fetched
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- device_name: (string)
- landscape_width: (string)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (string)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/device1/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the device1 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
delete /api/device1/{referenceId}/usergroup
get /api/device1/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the device1 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
device5
Resources in this group are related to device5
Returns a list of Device5
Create a new device5
get /api/device5
Returns a list of Device5
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/device5
Create a new device5
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a device5
Get device5 by id
Edit an existing device5
get /api/device5/{referenceId}
Get device5 by id
URI Parameters
- referenceId: required (string)
Reference id of the device5 to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/device5/{referenceId}
Edit an existing device5
URI Parameters
- referenceId: required (string)
Reference id of the device5 to be fetched
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/device5/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the device5 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
delete /api/device5/{referenceId}/usergroup
get /api/device5/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the device5 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
devices3
Resources in this group are related to devices3
Returns a list of Devices3
Create a new devices3
get /api/devices3
Returns a list of Devices3
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/devices3
Create a new devices3
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a devices3
Get devices3 by id
Edit an existing devices3
get /api/devices3/{referenceId}
Get devices3 by id
URI Parameters
- referenceId: required (string)
Reference id of the devices3 to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/devices3/{referenceId}
Edit an existing devices3
URI Parameters
- referenceId: required (string)
Reference id of the devices3 to be fetched
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/devices3/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the devices3 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
delete /api/devices3/{referenceId}/usergroup
get /api/devices3/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the devices3 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
image
Resources in this group are related to image
Returns a list of Image
Create a new image
get /api/image
Returns a list of Image
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- configuration: (string)
- created_at: (datetime)
- description: required (string)
- description_line1: required (string)
- description_line2: required (string)
- image: (string)
- image_url: required (number)
- port: (number)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/image
Create a new image
Body
Media type: application/json
Type: object
Properties- configuration: (string)
- created_at: (datetime)
- description: required (string)
- description_line1: required (string)
- description_line2: required (string)
- image: (string)
- image_url: required (number)
- port: (number)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- configuration: (string)
- created_at: (datetime)
- description: required (string)
- description_line1: required (string)
- description_line2: required (string)
- image: (string)
- image_url: required (number)
- port: (number)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a image
Get image by id
Edit an existing image
get /api/image/{referenceId}
Get image by id
URI Parameters
- referenceId: required (string)
Reference id of the image to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- configuration: (string)
- created_at: (datetime)
- description: required (string)
- description_line1: required (string)
- description_line2: required (string)
- image: (string)
- image_url: required (number)
- port: (number)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/image/{referenceId}
Edit an existing image
URI Parameters
- referenceId: required (string)
Reference id of the image to be fetched
Body
Media type: application/json
Type: object
Properties- configuration: (string)
- created_at: (datetime)
- description: required (string)
- description_line1: required (string)
- description_line2: required (string)
- image: (string)
- image_url: required (number)
- port: (number)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- configuration: (string)
- created_at: (datetime)
- description: required (string)
- description_line1: required (string)
- description_line2: required (string)
- image: (string)
- image_url: required (number)
- port: (number)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related package from the parent object
Returns a list of Package
get /api/image/{referenceId}/package
Returns a list of Package
URI Parameters
- referenceId: required (string)
Reference id of the image to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cost: (number)
- created_at: (datetime)
- description: required (string)
- display_order: (number)
- domain_name: (string)
- package_name: (string)
- reference_id: (string)
- tags: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/image/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the image to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
get /api/image/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the image to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
instance
Resources in this group are related to instance
Returns a list of Instance
Create a new instance
get /api/instance
Returns a list of Instance
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cluster_instance_id: required (string)
- cluster_status: required (string)
- created_at: (datetime)
- domain_name: required (string)
- name: (string)
- namespace: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- valid_until: required (date-only)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/instance
Create a new instance
Body
Media type: application/json
Type: object
Properties- cluster_instance_id: required (string)
- cluster_status: required (string)
- created_at: (datetime)
- domain_name: required (string)
- name: (string)
- namespace: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- valid_until: required (date-only)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cluster_instance_id: required (string)
- cluster_status: required (string)
- created_at: (datetime)
- domain_name: required (string)
- name: (string)
- namespace: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- valid_until: required (date-only)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a instance
Get instance by id
Edit an existing instance
get /api/instance/{referenceId}
Get instance by id
URI Parameters
- referenceId: required (string)
Reference id of the instance to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cluster_instance_id: required (string)
- cluster_status: required (string)
- created_at: (datetime)
- domain_name: required (string)
- name: (string)
- namespace: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- valid_until: required (date-only)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/instance/{referenceId}
Edit an existing instance
URI Parameters
- referenceId: required (string)
Reference id of the instance to be fetched
Body
Media type: application/json
Type: object
Properties- cluster_instance_id: required (string)
- cluster_status: required (string)
- created_at: (datetime)
- domain_name: required (string)
- name: (string)
- namespace: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- valid_until: required (date-only)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cluster_instance_id: required (string)
- cluster_status: required (string)
- created_at: (datetime)
- domain_name: required (string)
- name: (string)
- namespace: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- valid_until: required (date-only)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related package from the parent object
Returns a list of Package
get /api/instance/{referenceId}/package
Returns a list of Package
URI Parameters
- referenceId: required (string)
Reference id of the instance to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cost: (number)
- created_at: (datetime)
- description: required (string)
- display_order: (number)
- domain_name: (string)
- package_name: (string)
- reference_id: (string)
- tags: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/instance/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the instance to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
delete /api/instance/{referenceId}/usergroup
get /api/instance/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the instance to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
json_schema
Resources in this group are related to json_schema
Returns a list of Json schema
Create a new json_schema
get /api/json_schema
Returns a list of Json schema
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- json_schema: (string)
- reference_id: (string)
- schema_name: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/json_schema
Create a new json_schema
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- json_schema: (string)
- reference_id: (string)
- schema_name: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- json_schema: (string)
- reference_id: (string)
- schema_name: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a json_schema
Get json_schema by id
Edit an existing json_schema
get /api/json_schema/{referenceId}
Get json_schema by id
URI Parameters
- referenceId: required (string)
Reference id of the json_schema to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- json_schema: (string)
- reference_id: (string)
- schema_name: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/json_schema/{referenceId}
Edit an existing json_schema
URI Parameters
- referenceId: required (string)
Reference id of the json_schema to be fetched
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- json_schema: (string)
- reference_id: (string)
- schema_name: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- json_schema: (string)
- reference_id: (string)
- schema_name: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/json_schema/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the json_schema to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
delete /api/json_schema/{referenceId}/usergroup
get /api/json_schema/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the json_schema to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
marketplace
Resources in this group are related to marketplace
Returns a list of Marketplace
Create a new marketplace
get /api/marketplace
Returns a list of Marketplace
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- endpoint: (string)
- name: (string)
- reference_id: (string)
- root_path: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/marketplace
Create a new marketplace
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- endpoint: (string)
- name: (string)
- reference_id: (string)
- root_path: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- endpoint: (string)
- name: (string)
- reference_id: (string)
- root_path: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a marketplace
Get marketplace by id
Edit an existing marketplace
get /api/marketplace/{referenceId}
Get marketplace by id
URI Parameters
- referenceId: required (string)
Reference id of the marketplace to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- endpoint: (string)
- name: (string)
- reference_id: (string)
- root_path: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/marketplace/{referenceId}
Edit an existing marketplace
URI Parameters
- referenceId: required (string)
Reference id of the marketplace to be fetched
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- endpoint: (string)
- name: (string)
- reference_id: (string)
- root_path: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- endpoint: (string)
- name: (string)
- reference_id: (string)
- root_path: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/marketplace/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the marketplace to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
delete /api/marketplace/{referenceId}/usergroup
get /api/marketplace/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the marketplace to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
oauth_connect
Resources in this group are related to oauth_connect
Returns a list of Oauth connect
Create a new oauth_connect
get /api/oauth_connect
Returns a list of Oauth connect
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- allow_login: (boolean)
- auth_url: (string)
- client_id: (string)
- client_secret: (string)
- created_at: (datetime)
- name: (string)
- redirect_uri: (string)
- reference_id: (string)
- response_type: (string)
- scope: (string)
- token_url: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/oauth_connect
Create a new oauth_connect
Body
Media type: application/json
Type: object
Properties- allow_login: (boolean)
- auth_url: (string)
- client_id: (string)
- client_secret: (string)
- created_at: (datetime)
- name: (string)
- redirect_uri: (string)
- reference_id: (string)
- response_type: (string)
- scope: (string)
- token_url: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- allow_login: (boolean)
- auth_url: (string)
- client_id: (string)
- client_secret: (string)
- created_at: (datetime)
- name: (string)
- redirect_uri: (string)
- reference_id: (string)
- response_type: (string)
- scope: (string)
- token_url: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a oauth_connect
Get oauth_connect by id
Edit an existing oauth_connect
get /api/oauth_connect/{referenceId}
Get oauth_connect by id
URI Parameters
- referenceId: required (string)
Reference id of the oauth_connect to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- allow_login: (boolean)
- auth_url: (string)
- client_id: (string)
- client_secret: (string)
- created_at: (datetime)
- name: (string)
- redirect_uri: (string)
- reference_id: (string)
- response_type: (string)
- scope: (string)
- token_url: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/oauth_connect/{referenceId}
Edit an existing oauth_connect
URI Parameters
- referenceId: required (string)
Reference id of the oauth_connect to be fetched
Body
Media type: application/json
Type: object
Properties- allow_login: (boolean)
- auth_url: (string)
- client_id: (string)
- client_secret: (string)
- created_at: (datetime)
- name: (string)
- redirect_uri: (string)
- reference_id: (string)
- response_type: (string)
- scope: (string)
- token_url: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- allow_login: (boolean)
- auth_url: (string)
- client_id: (string)
- client_secret: (string)
- created_at: (datetime)
- name: (string)
- redirect_uri: (string)
- reference_id: (string)
- response_type: (string)
- scope: (string)
- token_url: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related oauth_token from the parent object
Returns a list of Oauth token
delete /api/oauth_connect/{referenceId}/oauth_token
get /api/oauth_connect/{referenceId}/oauth_token
Returns a list of Oauth token
URI Parameters
- referenceId: required (string)
Reference id of the oauth_connect to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- access_token: (string)
- created_at: (datetime)
- expires_in: (number)
- reference_id: (string)
- refresh_token: (string)
- token_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
delete /api/oauth_connect/{referenceId}/user
get /api/oauth_connect/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the oauth_connect to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
delete /api/oauth_connect/{referenceId}/usergroup
get /api/oauth_connect/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the oauth_connect to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
oauth_token
Resources in this group are related to oauth_token
Returns a list of Oauth token
Create a new oauth_token
get /api/oauth_token
Returns a list of Oauth token
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- access_token: (string)
- created_at: (datetime)
- expires_in: (number)
- reference_id: (string)
- refresh_token: (string)
- token_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/oauth_token
Create a new oauth_token
Body
Media type: application/json
Type: object
Properties- access_token: (string)
- created_at: (datetime)
- expires_in: (number)
- reference_id: (string)
- refresh_token: (string)
- token_type: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- access_token: (string)
- created_at: (datetime)
- expires_in: (number)
- reference_id: (string)
- refresh_token: (string)
- token_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a oauth_token
Get oauth_token by id
Edit an existing oauth_token
get /api/oauth_token/{referenceId}
Get oauth_token by id
URI Parameters
- referenceId: required (string)
Reference id of the oauth_token to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- access_token: (string)
- created_at: (datetime)
- expires_in: (number)
- reference_id: (string)
- refresh_token: (string)
- token_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/oauth_token/{referenceId}
Edit an existing oauth_token
URI Parameters
- referenceId: required (string)
Reference id of the oauth_token to be fetched
Body
Media type: application/json
Type: object
Properties- access_token: (string)
- created_at: (datetime)
- expires_in: (number)
- reference_id: (string)
- refresh_token: (string)
- token_type: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- access_token: (string)
- created_at: (datetime)
- expires_in: (number)
- reference_id: (string)
- refresh_token: (string)
- token_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related cloud_store from the parent object
Returns a list of Cloud store
delete /api/oauth_token/{referenceId}/cloud_store
get /api/oauth_token/{referenceId}/cloud_store
Returns a list of Cloud store
URI Parameters
- referenceId: required (string)
Reference id of the oauth_token to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- root_path: (string)
- store_parameters: (string)
- store_provider: (string)
- store_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related data_exchange from the parent object
Returns a list of Data exchange
delete /api/oauth_token/{referenceId}/data_exchange
get /api/oauth_token/{referenceId}/data_exchange
Returns a list of Data exchange
URI Parameters
- referenceId: required (string)
Reference id of the oauth_token to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- attributes: (string)
- created_at: (datetime)
- name: (string)
- options: (string)
- reference_id: (string)
- source_attributes: (string)
- source_type: (string)
- target_attributes: (string)
- target_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related oauth_connect from the parent object
Returns a list of Oauth connect
delete /api/oauth_token/{referenceId}/oauth_connect
get /api/oauth_token/{referenceId}/oauth_connect
Returns a list of Oauth connect
URI Parameters
- referenceId: required (string)
Reference id of the oauth_token to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- allow_login: (boolean)
- auth_url: (string)
- client_id: (string)
- client_secret: (string)
- created_at: (datetime)
- name: (string)
- redirect_uri: (string)
- reference_id: (string)
- response_type: (string)
- scope: (string)
- token_url: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/oauth_token/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the oauth_token to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
delete /api/oauth_token/{referenceId}/usergroup
get /api/oauth_token/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the oauth_token to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
package
Resources in this group are related to package
Returns a list of Package
Create a new package
get /api/package
Returns a list of Package
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cost: (number)
- created_at: (datetime)
- description: required (string)
- display_order: (number)
- domain_name: (string)
- package_name: (string)
- reference_id: (string)
- tags: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/package
Create a new package
Body
Media type: application/json
Type: object
Properties- cost: (number)
- created_at: (datetime)
- description: required (string)
- display_order: (number)
- domain_name: (string)
- package_name: (string)
- reference_id: (string)
- tags: required (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cost: (number)
- created_at: (datetime)
- description: required (string)
- display_order: (number)
- domain_name: (string)
- package_name: (string)
- reference_id: (string)
- tags: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a package
Get package by id
Edit an existing package
get /api/package/{referenceId}
Get package by id
URI Parameters
- referenceId: required (string)
Reference id of the package to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cost: (number)
- created_at: (datetime)
- description: required (string)
- display_order: (number)
- domain_name: (string)
- package_name: (string)
- reference_id: (string)
- tags: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/package/{referenceId}
Edit an existing package
URI Parameters
- referenceId: required (string)
Reference id of the package to be fetched
Body
Media type: application/json
Type: object
Properties- cost: (number)
- created_at: (datetime)
- description: required (string)
- display_order: (number)
- domain_name: (string)
- package_name: (string)
- reference_id: (string)
- tags: required (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cost: (number)
- created_at: (datetime)
- description: required (string)
- display_order: (number)
- domain_name: (string)
- package_name: (string)
- reference_id: (string)
- tags: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related image from the parent object
Returns a list of Image
get /api/package/{referenceId}/image
Returns a list of Image
URI Parameters
- referenceId: required (string)
Reference id of the package to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- configuration: (string)
- created_at: (datetime)
- description: required (string)
- description_line1: required (string)
- description_line2: required (string)
- image: (string)
- image_url: required (number)
- port: (number)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related instance from the parent object
Returns a list of Instance
get /api/package/{referenceId}/instance
Returns a list of Instance
URI Parameters
- referenceId: required (string)
Reference id of the package to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cluster_instance_id: required (string)
- cluster_status: required (string)
- created_at: (datetime)
- domain_name: required (string)
- name: (string)
- namespace: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- valid_until: required (date-only)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related payment from the parent object
Returns a list of Payment
get /api/package/{referenceId}/payment
Returns a list of Payment
URI Parameters
- referenceId: required (string)
Reference id of the package to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- amount: (number)
- created_at: (datetime)
- payment_source: required (string)
- reference_id: (string)
- shared_reference_id: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/package/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the package to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
delete /api/package/{referenceId}/usergroup
get /api/package/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the package to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
payment
Resources in this group are related to payment
Returns a list of Payment
Create a new payment
get /api/payment
Returns a list of Payment
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- amount: (number)
- created_at: (datetime)
- payment_source: required (string)
- reference_id: (string)
- shared_reference_id: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/payment
Create a new payment
Body
Media type: application/json
Type: object
Properties- amount: (number)
- created_at: (datetime)
- payment_source: required (string)
- reference_id: (string)
- shared_reference_id: required (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- amount: (number)
- created_at: (datetime)
- payment_source: required (string)
- reference_id: (string)
- shared_reference_id: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a payment
Get payment by id
Edit an existing payment
get /api/payment/{referenceId}
Get payment by id
URI Parameters
- referenceId: required (string)
Reference id of the payment to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- amount: (number)
- created_at: (datetime)
- payment_source: required (string)
- reference_id: (string)
- shared_reference_id: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/payment/{referenceId}
Edit an existing payment
URI Parameters
- referenceId: required (string)
Reference id of the payment to be fetched
Body
Media type: application/json
Type: object
Properties- amount: (number)
- created_at: (datetime)
- payment_source: required (string)
- reference_id: (string)
- shared_reference_id: required (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- amount: (number)
- created_at: (datetime)
- payment_source: required (string)
- reference_id: (string)
- shared_reference_id: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related package from the parent object
Returns a list of Package
get /api/payment/{referenceId}/package
Returns a list of Package
URI Parameters
- referenceId: required (string)
Reference id of the payment to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cost: (number)
- created_at: (datetime)
- description: required (string)
- display_order: (number)
- domain_name: (string)
- package_name: (string)
- reference_id: (string)
- tags: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/payment/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the payment to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
delete /api/payment/{referenceId}/usergroup
get /api/payment/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the payment to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
site
Resources in this group are related to site
Returns a list of Site
Create a new site
get /api/site
Returns a list of Site
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- hostname: (string)
- name: (string)
- path: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/site
Create a new site
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- hostname: (string)
- name: (string)
- path: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- hostname: (string)
- name: (string)
- path: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a site
Get site by id
Edit an existing site
get /api/site/{referenceId}
Get site by id
URI Parameters
- referenceId: required (string)
Reference id of the site to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- hostname: (string)
- name: (string)
- path: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/site/{referenceId}
Edit an existing site
URI Parameters
- referenceId: required (string)
Reference id of the site to be fetched
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- hostname: (string)
- name: (string)
- path: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- hostname: (string)
- name: (string)
- path: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related cloud_store from the parent object
Returns a list of Cloud store
get /api/site/{referenceId}/cloud_store
Returns a list of Cloud store
URI Parameters
- referenceId: required (string)
Reference id of the site to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- root_path: (string)
- store_parameters: (string)
- store_provider: (string)
- store_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/site/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the site to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
get /api/site/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the site to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
smd
Resources in this group are related to smd
Returns a list of Smd
Create a new smd
get /api/smd
Returns a list of Smd
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- events: (string)
- initial_state: (string)
- label: (string)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/smd
Create a new smd
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- events: (string)
- initial_state: (string)
- label: (string)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- events: (string)
- initial_state: (string)
- label: (string)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a smd
Get smd by id
Edit an existing smd
get /api/smd/{referenceId}
Get smd by id
URI Parameters
- referenceId: required (string)
Reference id of the smd to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- events: (string)
- initial_state: (string)
- label: (string)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/smd/{referenceId}
Edit an existing smd
URI Parameters
- referenceId: required (string)
Reference id of the smd to be fetched
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- events: (string)
- initial_state: (string)
- label: (string)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- events: (string)
- initial_state: (string)
- label: (string)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/smd/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the smd to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
get /api/smd/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the smd to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related world from the parent object
Returns a list of World
get /api/smd/{referenceId}/world
Returns a list of World
URI Parameters
- referenceId: required (string)
Reference id of the smd to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- default_order: required (number)
- default_permission: (number)
- icon: required (string)
- is_hidden: (boolean)
- is_join_table: (boolean)
- is_state_tracking_enabled: (boolean)
- is_top_level: (boolean)
- reference_id: (string)
- table_name: (string)
- updated_at: required (datetime)
- version: (number)
- world_schema_json: (string)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_column_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
stream
Resources in this group are related to stream
Returns a list of Stream
Create a new stream
get /api/stream
Returns a list of Stream
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- reference_id: (string)
- stream_contract: (string)
- stream_name: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/stream
Create a new stream
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- reference_id: (string)
- stream_contract: (string)
- stream_name: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- reference_id: (string)
- stream_contract: (string)
- stream_name: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a stream
Get stream by id
Edit an existing stream
get /api/stream/{referenceId}
Get stream by id
URI Parameters
- referenceId: required (string)
Reference id of the stream to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- reference_id: (string)
- stream_contract: (string)
- stream_name: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/stream/{referenceId}
Edit an existing stream
URI Parameters
- referenceId: required (string)
Reference id of the stream to be fetched
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- reference_id: (string)
- stream_contract: (string)
- stream_name: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- reference_id: (string)
- stream_contract: (string)
- stream_name: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/stream/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the stream to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
get /api/stream/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the stream to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
timeline
Resources in this group are related to timeline
Returns a list of Timeline
Create a new timeline
get /api/timeline
Returns a list of Timeline
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- event_type: (string)
- payload: required (string)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/timeline
Create a new timeline
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- event_type: (string)
- payload: required (string)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- event_type: (string)
- payload: required (string)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a timeline
Get timeline by id
Edit an existing timeline
get /api/timeline/{referenceId}
Get timeline by id
URI Parameters
- referenceId: required (string)
Reference id of the timeline to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- event_type: (string)
- payload: required (string)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/timeline/{referenceId}
Edit an existing timeline
URI Parameters
- referenceId: required (string)
Reference id of the timeline to be fetched
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- event_type: (string)
- payload: required (string)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- event_type: (string)
- payload: required (string)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/timeline/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the timeline to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
delete /api/timeline/{referenceId}/usergroup
get /api/timeline/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the timeline to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related world from the parent object
Returns a list of World
get /api/timeline/{referenceId}/world
Returns a list of World
URI Parameters
- referenceId: required (string)
Reference id of the timeline to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- default_order: required (number)
- default_permission: (number)
- icon: required (string)
- is_hidden: (boolean)
- is_join_table: (boolean)
- is_state_tracking_enabled: (boolean)
- is_top_level: (boolean)
- reference_id: (string)
- table_name: (string)
- updated_at: required (datetime)
- version: (number)
- world_schema_json: (string)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_column_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
transaction
Resources in this group are related to transaction
Returns a list of Transaction
Create a new transaction
get /api/transaction
Returns a list of Transaction
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- amount: (number)
- created_at: (datetime)
- payment_reference: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/transaction
Create a new transaction
Body
Media type: application/json
Type: object
Properties- amount: (number)
- created_at: (datetime)
- payment_reference: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- amount: (number)
- created_at: (datetime)
- payment_reference: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a transaction
Get transaction by id
Edit an existing transaction
get /api/transaction/{referenceId}
Get transaction by id
URI Parameters
- referenceId: required (string)
Reference id of the transaction to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- amount: (number)
- created_at: (datetime)
- payment_reference: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/transaction/{referenceId}
Edit an existing transaction
URI Parameters
- referenceId: required (string)
Reference id of the transaction to be fetched
Body
Media type: application/json
Type: object
Properties- amount: (number)
- created_at: (datetime)
- payment_reference: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- amount: (number)
- created_at: (datetime)
- payment_reference: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/transaction/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the transaction to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
delete /api/transaction/{referenceId}/usergroup
get /api/transaction/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the transaction to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
user
Resources in this group are related to user
Returns a list of User
Create a new user
get /api/user
Returns a list of User
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/user
Create a new user
Body
Media type: application/json
Type: object
Properties- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a user
Get user by id
Edit an existing user
get /api/user/{referenceId}
Get user by id
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/user/{referenceId}
Edit an existing user
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Body
Media type: application/json
Type: object
Properties- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related action from the parent object
Returns a list of Action
get /api/user/{referenceId}/action
Returns a list of Action
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- action_name: (string)
- action_schema: (string)
- created_at: (datetime)
- instance_optional: (boolean)
- label: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related cloud_store from the parent object
Returns a list of Cloud store
get /api/user/{referenceId}/cloud_store
Returns a list of Cloud store
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- root_path: (string)
- store_parameters: (string)
- store_provider: (string)
- store_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related data_exchange from the parent object
Returns a list of Data exchange
delete /api/user/{referenceId}/data_exchange
get /api/user/{referenceId}/data_exchange
Returns a list of Data exchange
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- attributes: (string)
- created_at: (datetime)
- name: (string)
- options: (string)
- reference_id: (string)
- source_attributes: (string)
- source_type: (string)
- target_attributes: (string)
- target_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related dev1 from the parent object
Returns a list of Dev1
get /api/user/{referenceId}/dev1
Returns a list of Dev1
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related device1 from the parent object
Returns a list of Device1
get /api/user/{referenceId}/device1
Returns a list of Device1
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (string)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related device5 from the parent object
Returns a list of Device5
get /api/user/{referenceId}/device5
Returns a list of Device5
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related devices3 from the parent object
Returns a list of Devices3
get /api/user/{referenceId}/devices3
Returns a list of Devices3
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related image from the parent object
Returns a list of Image
get /api/user/{referenceId}/image
Returns a list of Image
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- configuration: (string)
- created_at: (datetime)
- description: required (string)
- description_line1: required (string)
- description_line2: required (string)
- image: (string)
- image_url: required (number)
- port: (number)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related instance from the parent object
Returns a list of Instance
get /api/user/{referenceId}/instance
Returns a list of Instance
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cluster_instance_id: required (string)
- cluster_status: required (string)
- created_at: (datetime)
- domain_name: required (string)
- name: (string)
- namespace: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- valid_until: required (date-only)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related json_schema from the parent object
Returns a list of Json schema
get /api/user/{referenceId}/json_schema
Returns a list of Json schema
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- json_schema: (string)
- reference_id: (string)
- schema_name: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related marketplace from the parent object
Returns a list of Marketplace
get /api/user/{referenceId}/marketplace
Returns a list of Marketplace
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- endpoint: (string)
- name: (string)
- reference_id: (string)
- root_path: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related oauth_connect from the parent object
Returns a list of Oauth connect
delete /api/user/{referenceId}/oauth_connect
get /api/user/{referenceId}/oauth_connect
Returns a list of Oauth connect
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- allow_login: (boolean)
- auth_url: (string)
- client_id: (string)
- client_secret: (string)
- created_at: (datetime)
- name: (string)
- redirect_uri: (string)
- reference_id: (string)
- response_type: (string)
- scope: (string)
- token_url: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related oauth_token from the parent object
Returns a list of Oauth token
get /api/user/{referenceId}/oauth_token
Returns a list of Oauth token
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- access_token: (string)
- created_at: (datetime)
- expires_in: (number)
- reference_id: (string)
- refresh_token: (string)
- token_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related package from the parent object
Returns a list of Package
get /api/user/{referenceId}/package
Returns a list of Package
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cost: (number)
- created_at: (datetime)
- description: required (string)
- display_order: (number)
- domain_name: (string)
- package_name: (string)
- reference_id: (string)
- tags: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related payment from the parent object
Returns a list of Payment
get /api/user/{referenceId}/payment
Returns a list of Payment
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- amount: (number)
- created_at: (datetime)
- payment_source: required (string)
- reference_id: (string)
- shared_reference_id: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related site from the parent object
Returns a list of Site
get /api/user/{referenceId}/site
Returns a list of Site
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- hostname: (string)
- name: (string)
- path: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related smd from the parent object
Returns a list of Smd
get /api/user/{referenceId}/smd
Returns a list of Smd
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- events: (string)
- initial_state: (string)
- label: (string)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related stream from the parent object
Returns a list of Stream
get /api/user/{referenceId}/stream
Returns a list of Stream
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- reference_id: (string)
- stream_contract: (string)
- stream_name: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related timeline from the parent object
Returns a list of Timeline
get /api/user/{referenceId}/timeline
Returns a list of Timeline
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- event_type: (string)
- payload: required (string)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related transaction from the parent object
Returns a list of Transaction
get /api/user/{referenceId}/transaction
Returns a list of Transaction
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- amount: (number)
- created_at: (datetime)
- payment_reference: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/user/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
get /api/user/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related ware1 from the parent object
Returns a list of Ware1
get /api/user/{referenceId}/ware1
Returns a list of Ware1
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related ware3 from the parent object
Returns a list of Ware3
get /api/user/{referenceId}/ware3
Returns a list of Ware3
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (string)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (string)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (string)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related ware6 from the parent object
Returns a list of Ware6
get /api/user/{referenceId}/ware6
Returns a list of Ware6
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (number)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (number)
- col_2nd_defect_minor: required (number)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (date-only)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (number)
- created_at: (datetime)
- dhu: required (number)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (number)
- total_major: required (number)
- total_minor: required (number)
- total_no_of_pieces_inspected: required (number)
- total_pcs_inspected: required (number)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related ware7 from the parent object
Returns a list of Ware7
get /api/user/{referenceId}/ware7
Returns a list of Ware7
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- 1ST DEFECT: required (string)
- 1ST DEFECT : MAJOR: required (number)
- 1ST DEFECT : MINOR: required (number)
- 1ST TIME AUDIT RESULT: required (string)
- 2ND DEFECT: required (string)
- 2ND DEFECT : MAJOR: required (number)
- 2ND DEFECT : MINOR: required (number)
- 2ND TIME AUDIT RESULT: required (string)
- 3RD DEFECT: required (string)
- 3RD DEFECT : MAJOR: required (number)
- 3RD DEFECT : MINOR: required (number)
- 4TH DEFECT: required (string)
- 4TH DEFECT : MAJOR: required (number)
- 4TH DEFECT : MINOR: required (boolean)
- 5TH DEFECT: required (string)
- 5TH DEFECT : MAJOR: required (number)
- 5TH DEFECT : MINOR: required (number)
- AUDIT FINAL RESULT: required (string)
- BRAND: required (string)
- CATEGORY: required (string)
- COUNT and IMAGE OF DAMAGED CARTONS: required (number)
- Closed By: required (boolean)
- Closed On (UTC +05:30): required (boolean)
- Colors: required (string)
- DHU: required (number)
- Date: required (date-only)
- Due Date: required (boolean)
- Employee ID: required (number)
- FACTORY NAME: (string)
- FIELD QA NAME: required (string)
- GENDER: required (string)
- GENERAL REMARKS: required (string)
- INVOICE NUMBER: (string)
- INVOICE QTY: (number)
- Level 1 - Date (UTC +05:30): required (boolean)
- Level 1 By: required (boolean)
- NAME OF THE PERSON APPROVING THE FAILED AUDIT (only name in CAPS): required (string)
- NO OF BOXES RECD: (number)
- Notify JEANS- Quality Head: required (string)
- Notify KNITS- Quality Head: required (string)
- Notify SBT- Quality Head: required (string)
- Notify SHIRTS- Quality Head: required (string)
- Notify WOMENSWEAR- Quality Head: required (string)
- PRODUCT TYPE: required (string)
- RTV: required (string)
- Reference No: (string)
- Role: required (string)
- SEASON: required (string)
- STYLE CODE (CAPS ON): (string)
- Store: required (string)
- Submission Date (UTC +05:30): (datetime)
- Submitted By: required (string)
- Submitted By (login_id): required (string)
- TOTAL DEFECTS: required (string)
- TOTAL MAJOR: required (number)
- TOTAL MINOR: required (number)
- TOTAL NO. OF PIECES INSPECTED: required (number)
- TOTAL PCS INSPECTED: required (number)
- User: required (string)
- VENDOR NAME: (string)
- WAREHOUSE NAME: required (string)
- created_at: (datetime)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related warehouse from the parent object
Returns a list of Warehouse
get /api/user/{referenceId}/warehouse
Returns a list of Warehouse
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related world from the parent object
Returns a list of World
get /api/user/{referenceId}/world
Returns a list of World
URI Parameters
- referenceId: required (string)
Reference id of the user to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- default_order: required (number)
- default_permission: (number)
- icon: required (string)
- is_hidden: (boolean)
- is_join_table: (boolean)
- is_state_tracking_enabled: (boolean)
- is_top_level: (boolean)
- reference_id: (string)
- table_name: (string)
- updated_at: required (datetime)
- version: (number)
- world_schema_json: (string)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_column_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
usergroup
Resources in this group are related to usergroup
Returns a list of Usergroup
Create a new usergroup
get /api/usergroup
Returns a list of Usergroup
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/usergroup
Create a new usergroup
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a usergroup
Get usergroup by id
Edit an existing usergroup
get /api/usergroup/{referenceId}
Get usergroup by id
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/usergroup/{referenceId}
Edit an existing usergroup
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related action from the parent object
Returns a list of Action
get /api/usergroup/{referenceId}/action
Returns a list of Action
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- action_name: (string)
- action_schema: (string)
- created_at: (datetime)
- instance_optional: (boolean)
- label: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related cloud_store from the parent object
Returns a list of Cloud store
delete /api/usergroup/{referenceId}/cloud_store
get /api/usergroup/{referenceId}/cloud_store
Returns a list of Cloud store
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- root_path: (string)
- store_parameters: (string)
- store_provider: (string)
- store_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related data_exchange from the parent object
Returns a list of Data exchange
delete /api/usergroup/{referenceId}/data_exchange
get /api/usergroup/{referenceId}/data_exchange
Returns a list of Data exchange
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- attributes: (string)
- created_at: (datetime)
- name: (string)
- options: (string)
- reference_id: (string)
- source_attributes: (string)
- source_type: (string)
- target_attributes: (string)
- target_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related dev1 from the parent object
Returns a list of Dev1
get /api/usergroup/{referenceId}/dev1
Returns a list of Dev1
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related device1 from the parent object
Returns a list of Device1
delete /api/usergroup/{referenceId}/device1
get /api/usergroup/{referenceId}/device1
Returns a list of Device1
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (string)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related device5 from the parent object
Returns a list of Device5
delete /api/usergroup/{referenceId}/device5
get /api/usergroup/{referenceId}/device5
Returns a list of Device5
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related devices3 from the parent object
Returns a list of Devices3
delete /api/usergroup/{referenceId}/devices3
get /api/usergroup/{referenceId}/devices3
Returns a list of Devices3
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- device_name: (string)
- landscape_width: (number)
- os_version: (string)
- platform: (string)
- portrait_width: (number)
- reference_id: (string)
- release_date: (date-only)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related image from the parent object
Returns a list of Image
get /api/usergroup/{referenceId}/image
Returns a list of Image
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- configuration: (string)
- created_at: (datetime)
- description: required (string)
- description_line1: required (string)
- description_line2: required (string)
- image: (string)
- image_url: required (number)
- port: (number)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related instance from the parent object
Returns a list of Instance
delete /api/usergroup/{referenceId}/instance
get /api/usergroup/{referenceId}/instance
Returns a list of Instance
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cluster_instance_id: required (string)
- cluster_status: required (string)
- created_at: (datetime)
- domain_name: required (string)
- name: (string)
- namespace: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- valid_until: required (date-only)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related json_schema from the parent object
Returns a list of Json schema
delete /api/usergroup/{referenceId}/json_schema
get /api/usergroup/{referenceId}/json_schema
Returns a list of Json schema
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- json_schema: (string)
- reference_id: (string)
- schema_name: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related marketplace from the parent object
Returns a list of Marketplace
delete /api/usergroup/{referenceId}/marketplace
get /api/usergroup/{referenceId}/marketplace
Returns a list of Marketplace
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- endpoint: (string)
- name: (string)
- reference_id: (string)
- root_path: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related oauth_connect from the parent object
Returns a list of Oauth connect
delete /api/usergroup/{referenceId}/oauth_connect
get /api/usergroup/{referenceId}/oauth_connect
Returns a list of Oauth connect
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- allow_login: (boolean)
- auth_url: (string)
- client_id: (string)
- client_secret: (string)
- created_at: (datetime)
- name: (string)
- redirect_uri: (string)
- reference_id: (string)
- response_type: (string)
- scope: (string)
- token_url: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related oauth_token from the parent object
Returns a list of Oauth token
delete /api/usergroup/{referenceId}/oauth_token
get /api/usergroup/{referenceId}/oauth_token
Returns a list of Oauth token
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- access_token: (string)
- created_at: (datetime)
- expires_in: (number)
- reference_id: (string)
- refresh_token: (string)
- token_type: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related package from the parent object
Returns a list of Package
delete /api/usergroup/{referenceId}/package
get /api/usergroup/{referenceId}/package
Returns a list of Package
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- cost: (number)
- created_at: (datetime)
- description: required (string)
- display_order: (number)
- domain_name: (string)
- package_name: (string)
- reference_id: (string)
- tags: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related payment from the parent object
Returns a list of Payment
delete /api/usergroup/{referenceId}/payment
get /api/usergroup/{referenceId}/payment
Returns a list of Payment
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- amount: (number)
- created_at: (datetime)
- payment_source: required (string)
- reference_id: (string)
- shared_reference_id: required (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related site from the parent object
Returns a list of Site
get /api/usergroup/{referenceId}/site
Returns a list of Site
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- hostname: (string)
- name: (string)
- path: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related smd from the parent object
Returns a list of Smd
get /api/usergroup/{referenceId}/smd
Returns a list of Smd
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- events: (string)
- initial_state: (string)
- label: (string)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related stream from the parent object
Returns a list of Stream
get /api/usergroup/{referenceId}/stream
Returns a list of Stream
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- reference_id: (string)
- stream_contract: (string)
- stream_name: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related timeline from the parent object
Returns a list of Timeline
delete /api/usergroup/{referenceId}/timeline
get /api/usergroup/{referenceId}/timeline
Returns a list of Timeline
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- event_type: (string)
- payload: required (string)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related transaction from the parent object
Returns a list of Transaction
delete /api/usergroup/{referenceId}/transaction
get /api/usergroup/{referenceId}/transaction
Returns a list of Transaction
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- amount: (number)
- created_at: (datetime)
- payment_reference: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/usergroup/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related ware1 from the parent object
Returns a list of Ware1
get /api/usergroup/{referenceId}/ware1
Returns a list of Ware1
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related ware3 from the parent object
Returns a list of Ware3
get /api/usergroup/{referenceId}/ware3
Returns a list of Ware3
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (string)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (string)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (string)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related ware6 from the parent object
Returns a list of Ware6
get /api/usergroup/{referenceId}/ware6
Returns a list of Ware6
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (number)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (number)
- col_2nd_defect_minor: required (number)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (date-only)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (number)
- created_at: (datetime)
- dhu: required (number)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (number)
- total_major: required (number)
- total_minor: required (number)
- total_no_of_pieces_inspected: required (number)
- total_pcs_inspected: required (number)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related ware7 from the parent object
Returns a list of Ware7
get /api/usergroup/{referenceId}/ware7
Returns a list of Ware7
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- 1ST DEFECT: required (string)
- 1ST DEFECT : MAJOR: required (number)
- 1ST DEFECT : MINOR: required (number)
- 1ST TIME AUDIT RESULT: required (string)
- 2ND DEFECT: required (string)
- 2ND DEFECT : MAJOR: required (number)
- 2ND DEFECT : MINOR: required (number)
- 2ND TIME AUDIT RESULT: required (string)
- 3RD DEFECT: required (string)
- 3RD DEFECT : MAJOR: required (number)
- 3RD DEFECT : MINOR: required (number)
- 4TH DEFECT: required (string)
- 4TH DEFECT : MAJOR: required (number)
- 4TH DEFECT : MINOR: required (boolean)
- 5TH DEFECT: required (string)
- 5TH DEFECT : MAJOR: required (number)
- 5TH DEFECT : MINOR: required (number)
- AUDIT FINAL RESULT: required (string)
- BRAND: required (string)
- CATEGORY: required (string)
- COUNT and IMAGE OF DAMAGED CARTONS: required (number)
- Closed By: required (boolean)
- Closed On (UTC +05:30): required (boolean)
- Colors: required (string)
- DHU: required (number)
- Date: required (date-only)
- Due Date: required (boolean)
- Employee ID: required (number)
- FACTORY NAME: (string)
- FIELD QA NAME: required (string)
- GENDER: required (string)
- GENERAL REMARKS: required (string)
- INVOICE NUMBER: (string)
- INVOICE QTY: (number)
- Level 1 - Date (UTC +05:30): required (boolean)
- Level 1 By: required (boolean)
- NAME OF THE PERSON APPROVING THE FAILED AUDIT (only name in CAPS): required (string)
- NO OF BOXES RECD: (number)
- Notify JEANS- Quality Head: required (string)
- Notify KNITS- Quality Head: required (string)
- Notify SBT- Quality Head: required (string)
- Notify SHIRTS- Quality Head: required (string)
- Notify WOMENSWEAR- Quality Head: required (string)
- PRODUCT TYPE: required (string)
- RTV: required (string)
- Reference No: (string)
- Role: required (string)
- SEASON: required (string)
- STYLE CODE (CAPS ON): (string)
- Store: required (string)
- Submission Date (UTC +05:30): (datetime)
- Submitted By: required (string)
- Submitted By (login_id): required (string)
- TOTAL DEFECTS: required (string)
- TOTAL MAJOR: required (number)
- TOTAL MINOR: required (number)
- TOTAL NO. OF PIECES INSPECTED: required (number)
- TOTAL PCS INSPECTED: required (number)
- User: required (string)
- VENDOR NAME: (string)
- WAREHOUSE NAME: required (string)
- created_at: (datetime)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related warehouse from the parent object
Returns a list of Warehouse
delete /api/usergroup/{referenceId}/warehouse
get /api/usergroup/{referenceId}/warehouse
Returns a list of Warehouse
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related world from the parent object
Returns a list of World
get /api/usergroup/{referenceId}/world
Returns a list of World
URI Parameters
- referenceId: required (string)
Reference id of the usergroup to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- default_order: required (number)
- default_permission: (number)
- icon: required (string)
- is_hidden: (boolean)
- is_join_table: (boolean)
- is_state_tracking_enabled: (boolean)
- is_top_level: (boolean)
- reference_id: (string)
- table_name: (string)
- updated_at: required (datetime)
- version: (number)
- world_schema_json: (string)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_column_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
ware1
Resources in this group are related to ware1
Returns a list of Ware1
Create a new ware1
get /api/ware1
Returns a list of Ware1
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/ware1
Create a new ware1
Body
Media type: application/json
Type: object
Properties- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a ware1
Get ware1 by id
Edit an existing ware1
get /api/ware1/{referenceId}
Get ware1 by id
URI Parameters
- referenceId: required (string)
Reference id of the ware1 to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/ware1/{referenceId}
Edit an existing ware1
URI Parameters
- referenceId: required (string)
Reference id of the ware1 to be fetched
Body
Media type: application/json
Type: object
Properties- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/ware1/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the ware1 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
get /api/ware1/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the ware1 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
ware3
Resources in this group are related to ware3
Returns a list of Ware3
Create a new ware3
get /api/ware3
Returns a list of Ware3
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (string)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (string)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (string)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/ware3
Create a new ware3
Body
Media type: application/json
Type: object
Properties- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (string)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (string)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (string)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (string)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (string)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (string)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a ware3
Get ware3 by id
Edit an existing ware3
get /api/ware3/{referenceId}
Get ware3 by id
URI Parameters
- referenceId: required (string)
Reference id of the ware3 to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (string)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (string)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (string)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/ware3/{referenceId}
Edit an existing ware3
URI Parameters
- referenceId: required (string)
Reference id of the ware3 to be fetched
Body
Media type: application/json
Type: object
Properties- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (string)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (string)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (string)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (string)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (string)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (string)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/ware3/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the ware3 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
get /api/ware3/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the ware3 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
ware6
Resources in this group are related to ware6
Returns a list of Ware6
Create a new ware6
get /api/ware6
Returns a list of Ware6
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (number)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (number)
- col_2nd_defect_minor: required (number)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (date-only)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (number)
- created_at: (datetime)
- dhu: required (number)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (number)
- total_major: required (number)
- total_minor: required (number)
- total_no_of_pieces_inspected: required (number)
- total_pcs_inspected: required (number)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/ware6
Create a new ware6
Body
Media type: application/json
Type: object
Properties- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (number)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (number)
- col_2nd_defect_minor: required (number)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (date-only)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (number)
- created_at: (datetime)
- dhu: required (number)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (number)
- total_major: required (number)
- total_minor: required (number)
- total_no_of_pieces_inspected: required (number)
- total_pcs_inspected: required (number)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (number)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (number)
- col_2nd_defect_minor: required (number)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (date-only)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (number)
- created_at: (datetime)
- dhu: required (number)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (number)
- total_major: required (number)
- total_minor: required (number)
- total_no_of_pieces_inspected: required (number)
- total_pcs_inspected: required (number)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a ware6
Get ware6 by id
Edit an existing ware6
get /api/ware6/{referenceId}
Get ware6 by id
URI Parameters
- referenceId: required (string)
Reference id of the ware6 to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (number)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (number)
- col_2nd_defect_minor: required (number)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (date-only)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (number)
- created_at: (datetime)
- dhu: required (number)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (number)
- total_major: required (number)
- total_minor: required (number)
- total_no_of_pieces_inspected: required (number)
- total_pcs_inspected: required (number)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/ware6/{referenceId}
Edit an existing ware6
URI Parameters
- referenceId: required (string)
Reference id of the ware6 to be fetched
Body
Media type: application/json
Type: object
Properties- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (number)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (number)
- col_2nd_defect_minor: required (number)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (date-only)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (number)
- created_at: (datetime)
- dhu: required (number)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (number)
- total_major: required (number)
- total_minor: required (number)
- total_no_of_pieces_inspected: required (number)
- total_pcs_inspected: required (number)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (number)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (number)
- col_2nd_defect_minor: required (number)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (date-only)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (number)
- created_at: (datetime)
- dhu: required (number)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: required (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: required (string)
- invoice_qty: required (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: required (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: required (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: required (string)
- submission_date_utc0530: required (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (number)
- total_major: required (number)
- total_minor: required (number)
- total_no_of_pieces_inspected: required (number)
- total_pcs_inspected: required (number)
- updated_at: required (datetime)
- vendor_name: required (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/ware6/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the ware6 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
get /api/ware6/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the ware6 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
ware7
Resources in this group are related to ware7
Returns a list of Ware7
Create a new ware7
get /api/ware7
Returns a list of Ware7
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- 1ST DEFECT: required (string)
- 1ST DEFECT : MAJOR: required (number)
- 1ST DEFECT : MINOR: required (number)
- 1ST TIME AUDIT RESULT: required (string)
- 2ND DEFECT: required (string)
- 2ND DEFECT : MAJOR: required (number)
- 2ND DEFECT : MINOR: required (number)
- 2ND TIME AUDIT RESULT: required (string)
- 3RD DEFECT: required (string)
- 3RD DEFECT : MAJOR: required (number)
- 3RD DEFECT : MINOR: required (number)
- 4TH DEFECT: required (string)
- 4TH DEFECT : MAJOR: required (number)
- 4TH DEFECT : MINOR: required (boolean)
- 5TH DEFECT: required (string)
- 5TH DEFECT : MAJOR: required (number)
- 5TH DEFECT : MINOR: required (number)
- AUDIT FINAL RESULT: required (string)
- BRAND: required (string)
- CATEGORY: required (string)
- COUNT and IMAGE OF DAMAGED CARTONS: required (number)
- Closed By: required (boolean)
- Closed On (UTC +05:30): required (boolean)
- Colors: required (string)
- DHU: required (number)
- Date: required (date-only)
- Due Date: required (boolean)
- Employee ID: required (number)
- FACTORY NAME: (string)
- FIELD QA NAME: required (string)
- GENDER: required (string)
- GENERAL REMARKS: required (string)
- INVOICE NUMBER: (string)
- INVOICE QTY: (number)
- Level 1 - Date (UTC +05:30): required (boolean)
- Level 1 By: required (boolean)
- NAME OF THE PERSON APPROVING THE FAILED AUDIT (only name in CAPS): required (string)
- NO OF BOXES RECD: (number)
- Notify JEANS- Quality Head: required (string)
- Notify KNITS- Quality Head: required (string)
- Notify SBT- Quality Head: required (string)
- Notify SHIRTS- Quality Head: required (string)
- Notify WOMENSWEAR- Quality Head: required (string)
- PRODUCT TYPE: required (string)
- RTV: required (string)
- Reference No: (string)
- Role: required (string)
- SEASON: required (string)
- STYLE CODE (CAPS ON): (string)
- Store: required (string)
- Submission Date (UTC +05:30): (datetime)
- Submitted By: required (string)
- Submitted By (login_id): required (string)
- TOTAL DEFECTS: required (string)
- TOTAL MAJOR: required (number)
- TOTAL MINOR: required (number)
- TOTAL NO. OF PIECES INSPECTED: required (number)
- TOTAL PCS INSPECTED: required (number)
- User: required (string)
- VENDOR NAME: (string)
- WAREHOUSE NAME: required (string)
- created_at: (datetime)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/ware7
Create a new ware7
Body
Media type: application/json
Type: object
Properties- 1ST DEFECT: required (string)
- 1ST DEFECT : MAJOR: required (number)
- 1ST DEFECT : MINOR: required (number)
- 1ST TIME AUDIT RESULT: required (string)
- 2ND DEFECT: required (string)
- 2ND DEFECT : MAJOR: required (number)
- 2ND DEFECT : MINOR: required (number)
- 2ND TIME AUDIT RESULT: required (string)
- 3RD DEFECT: required (string)
- 3RD DEFECT : MAJOR: required (number)
- 3RD DEFECT : MINOR: required (number)
- 4TH DEFECT: required (string)
- 4TH DEFECT : MAJOR: required (number)
- 4TH DEFECT : MINOR: required (boolean)
- 5TH DEFECT: required (string)
- 5TH DEFECT : MAJOR: required (number)
- 5TH DEFECT : MINOR: required (number)
- AUDIT FINAL RESULT: required (string)
- BRAND: required (string)
- CATEGORY: required (string)
- COUNT and IMAGE OF DAMAGED CARTONS: required (number)
- Closed By: required (boolean)
- Closed On (UTC +05:30): required (boolean)
- Colors: required (string)
- DHU: required (number)
- Date: required (date-only)
- Due Date: required (boolean)
- Employee ID: required (number)
- FACTORY NAME: (string)
- FIELD QA NAME: required (string)
- GENDER: required (string)
- GENERAL REMARKS: required (string)
- INVOICE NUMBER: (string)
- INVOICE QTY: (number)
- Level 1 - Date (UTC +05:30): required (boolean)
- Level 1 By: required (boolean)
- NAME OF THE PERSON APPROVING THE FAILED AUDIT (only name in CAPS): required (string)
- NO OF BOXES RECD: (number)
- Notify JEANS- Quality Head: required (string)
- Notify KNITS- Quality Head: required (string)
- Notify SBT- Quality Head: required (string)
- Notify SHIRTS- Quality Head: required (string)
- Notify WOMENSWEAR- Quality Head: required (string)
- PRODUCT TYPE: required (string)
- RTV: required (string)
- Reference No: (string)
- Role: required (string)
- SEASON: required (string)
- STYLE CODE (CAPS ON): (string)
- Store: required (string)
- Submission Date (UTC +05:30): (datetime)
- Submitted By: required (string)
- Submitted By (login_id): required (string)
- TOTAL DEFECTS: required (string)
- TOTAL MAJOR: required (number)
- TOTAL MINOR: required (number)
- TOTAL NO. OF PIECES INSPECTED: required (number)
- TOTAL PCS INSPECTED: required (number)
- User: required (string)
- VENDOR NAME: (string)
- WAREHOUSE NAME: required (string)
- created_at: (datetime)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- 1ST DEFECT: required (string)
- 1ST DEFECT : MAJOR: required (number)
- 1ST DEFECT : MINOR: required (number)
- 1ST TIME AUDIT RESULT: required (string)
- 2ND DEFECT: required (string)
- 2ND DEFECT : MAJOR: required (number)
- 2ND DEFECT : MINOR: required (number)
- 2ND TIME AUDIT RESULT: required (string)
- 3RD DEFECT: required (string)
- 3RD DEFECT : MAJOR: required (number)
- 3RD DEFECT : MINOR: required (number)
- 4TH DEFECT: required (string)
- 4TH DEFECT : MAJOR: required (number)
- 4TH DEFECT : MINOR: required (boolean)
- 5TH DEFECT: required (string)
- 5TH DEFECT : MAJOR: required (number)
- 5TH DEFECT : MINOR: required (number)
- AUDIT FINAL RESULT: required (string)
- BRAND: required (string)
- CATEGORY: required (string)
- COUNT and IMAGE OF DAMAGED CARTONS: required (number)
- Closed By: required (boolean)
- Closed On (UTC +05:30): required (boolean)
- Colors: required (string)
- DHU: required (number)
- Date: required (date-only)
- Due Date: required (boolean)
- Employee ID: required (number)
- FACTORY NAME: (string)
- FIELD QA NAME: required (string)
- GENDER: required (string)
- GENERAL REMARKS: required (string)
- INVOICE NUMBER: (string)
- INVOICE QTY: (number)
- Level 1 - Date (UTC +05:30): required (boolean)
- Level 1 By: required (boolean)
- NAME OF THE PERSON APPROVING THE FAILED AUDIT (only name in CAPS): required (string)
- NO OF BOXES RECD: (number)
- Notify JEANS- Quality Head: required (string)
- Notify KNITS- Quality Head: required (string)
- Notify SBT- Quality Head: required (string)
- Notify SHIRTS- Quality Head: required (string)
- Notify WOMENSWEAR- Quality Head: required (string)
- PRODUCT TYPE: required (string)
- RTV: required (string)
- Reference No: (string)
- Role: required (string)
- SEASON: required (string)
- STYLE CODE (CAPS ON): (string)
- Store: required (string)
- Submission Date (UTC +05:30): (datetime)
- Submitted By: required (string)
- Submitted By (login_id): required (string)
- TOTAL DEFECTS: required (string)
- TOTAL MAJOR: required (number)
- TOTAL MINOR: required (number)
- TOTAL NO. OF PIECES INSPECTED: required (number)
- TOTAL PCS INSPECTED: required (number)
- User: required (string)
- VENDOR NAME: (string)
- WAREHOUSE NAME: required (string)
- created_at: (datetime)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a ware7
Get ware7 by id
Edit an existing ware7
get /api/ware7/{referenceId}
Get ware7 by id
URI Parameters
- referenceId: required (string)
Reference id of the ware7 to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- 1ST DEFECT: required (string)
- 1ST DEFECT : MAJOR: required (number)
- 1ST DEFECT : MINOR: required (number)
- 1ST TIME AUDIT RESULT: required (string)
- 2ND DEFECT: required (string)
- 2ND DEFECT : MAJOR: required (number)
- 2ND DEFECT : MINOR: required (number)
- 2ND TIME AUDIT RESULT: required (string)
- 3RD DEFECT: required (string)
- 3RD DEFECT : MAJOR: required (number)
- 3RD DEFECT : MINOR: required (number)
- 4TH DEFECT: required (string)
- 4TH DEFECT : MAJOR: required (number)
- 4TH DEFECT : MINOR: required (boolean)
- 5TH DEFECT: required (string)
- 5TH DEFECT : MAJOR: required (number)
- 5TH DEFECT : MINOR: required (number)
- AUDIT FINAL RESULT: required (string)
- BRAND: required (string)
- CATEGORY: required (string)
- COUNT and IMAGE OF DAMAGED CARTONS: required (number)
- Closed By: required (boolean)
- Closed On (UTC +05:30): required (boolean)
- Colors: required (string)
- DHU: required (number)
- Date: required (date-only)
- Due Date: required (boolean)
- Employee ID: required (number)
- FACTORY NAME: (string)
- FIELD QA NAME: required (string)
- GENDER: required (string)
- GENERAL REMARKS: required (string)
- INVOICE NUMBER: (string)
- INVOICE QTY: (number)
- Level 1 - Date (UTC +05:30): required (boolean)
- Level 1 By: required (boolean)
- NAME OF THE PERSON APPROVING THE FAILED AUDIT (only name in CAPS): required (string)
- NO OF BOXES RECD: (number)
- Notify JEANS- Quality Head: required (string)
- Notify KNITS- Quality Head: required (string)
- Notify SBT- Quality Head: required (string)
- Notify SHIRTS- Quality Head: required (string)
- Notify WOMENSWEAR- Quality Head: required (string)
- PRODUCT TYPE: required (string)
- RTV: required (string)
- Reference No: (string)
- Role: required (string)
- SEASON: required (string)
- STYLE CODE (CAPS ON): (string)
- Store: required (string)
- Submission Date (UTC +05:30): (datetime)
- Submitted By: required (string)
- Submitted By (login_id): required (string)
- TOTAL DEFECTS: required (string)
- TOTAL MAJOR: required (number)
- TOTAL MINOR: required (number)
- TOTAL NO. OF PIECES INSPECTED: required (number)
- TOTAL PCS INSPECTED: required (number)
- User: required (string)
- VENDOR NAME: (string)
- WAREHOUSE NAME: required (string)
- created_at: (datetime)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/ware7/{referenceId}
Edit an existing ware7
URI Parameters
- referenceId: required (string)
Reference id of the ware7 to be fetched
Body
Media type: application/json
Type: object
Properties- 1ST DEFECT: required (string)
- 1ST DEFECT : MAJOR: required (number)
- 1ST DEFECT : MINOR: required (number)
- 1ST TIME AUDIT RESULT: required (string)
- 2ND DEFECT: required (string)
- 2ND DEFECT : MAJOR: required (number)
- 2ND DEFECT : MINOR: required (number)
- 2ND TIME AUDIT RESULT: required (string)
- 3RD DEFECT: required (string)
- 3RD DEFECT : MAJOR: required (number)
- 3RD DEFECT : MINOR: required (number)
- 4TH DEFECT: required (string)
- 4TH DEFECT : MAJOR: required (number)
- 4TH DEFECT : MINOR: required (boolean)
- 5TH DEFECT: required (string)
- 5TH DEFECT : MAJOR: required (number)
- 5TH DEFECT : MINOR: required (number)
- AUDIT FINAL RESULT: required (string)
- BRAND: required (string)
- CATEGORY: required (string)
- COUNT and IMAGE OF DAMAGED CARTONS: required (number)
- Closed By: required (boolean)
- Closed On (UTC +05:30): required (boolean)
- Colors: required (string)
- DHU: required (number)
- Date: required (date-only)
- Due Date: required (boolean)
- Employee ID: required (number)
- FACTORY NAME: (string)
- FIELD QA NAME: required (string)
- GENDER: required (string)
- GENERAL REMARKS: required (string)
- INVOICE NUMBER: (string)
- INVOICE QTY: (number)
- Level 1 - Date (UTC +05:30): required (boolean)
- Level 1 By: required (boolean)
- NAME OF THE PERSON APPROVING THE FAILED AUDIT (only name in CAPS): required (string)
- NO OF BOXES RECD: (number)
- Notify JEANS- Quality Head: required (string)
- Notify KNITS- Quality Head: required (string)
- Notify SBT- Quality Head: required (string)
- Notify SHIRTS- Quality Head: required (string)
- Notify WOMENSWEAR- Quality Head: required (string)
- PRODUCT TYPE: required (string)
- RTV: required (string)
- Reference No: (string)
- Role: required (string)
- SEASON: required (string)
- STYLE CODE (CAPS ON): (string)
- Store: required (string)
- Submission Date (UTC +05:30): (datetime)
- Submitted By: required (string)
- Submitted By (login_id): required (string)
- TOTAL DEFECTS: required (string)
- TOTAL MAJOR: required (number)
- TOTAL MINOR: required (number)
- TOTAL NO. OF PIECES INSPECTED: required (number)
- TOTAL PCS INSPECTED: required (number)
- User: required (string)
- VENDOR NAME: (string)
- WAREHOUSE NAME: required (string)
- created_at: (datetime)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- 1ST DEFECT: required (string)
- 1ST DEFECT : MAJOR: required (number)
- 1ST DEFECT : MINOR: required (number)
- 1ST TIME AUDIT RESULT: required (string)
- 2ND DEFECT: required (string)
- 2ND DEFECT : MAJOR: required (number)
- 2ND DEFECT : MINOR: required (number)
- 2ND TIME AUDIT RESULT: required (string)
- 3RD DEFECT: required (string)
- 3RD DEFECT : MAJOR: required (number)
- 3RD DEFECT : MINOR: required (number)
- 4TH DEFECT: required (string)
- 4TH DEFECT : MAJOR: required (number)
- 4TH DEFECT : MINOR: required (boolean)
- 5TH DEFECT: required (string)
- 5TH DEFECT : MAJOR: required (number)
- 5TH DEFECT : MINOR: required (number)
- AUDIT FINAL RESULT: required (string)
- BRAND: required (string)
- CATEGORY: required (string)
- COUNT and IMAGE OF DAMAGED CARTONS: required (number)
- Closed By: required (boolean)
- Closed On (UTC +05:30): required (boolean)
- Colors: required (string)
- DHU: required (number)
- Date: required (date-only)
- Due Date: required (boolean)
- Employee ID: required (number)
- FACTORY NAME: (string)
- FIELD QA NAME: required (string)
- GENDER: required (string)
- GENERAL REMARKS: required (string)
- INVOICE NUMBER: (string)
- INVOICE QTY: (number)
- Level 1 - Date (UTC +05:30): required (boolean)
- Level 1 By: required (boolean)
- NAME OF THE PERSON APPROVING THE FAILED AUDIT (only name in CAPS): required (string)
- NO OF BOXES RECD: (number)
- Notify JEANS- Quality Head: required (string)
- Notify KNITS- Quality Head: required (string)
- Notify SBT- Quality Head: required (string)
- Notify SHIRTS- Quality Head: required (string)
- Notify WOMENSWEAR- Quality Head: required (string)
- PRODUCT TYPE: required (string)
- RTV: required (string)
- Reference No: (string)
- Role: required (string)
- SEASON: required (string)
- STYLE CODE (CAPS ON): (string)
- Store: required (string)
- Submission Date (UTC +05:30): (datetime)
- Submitted By: required (string)
- Submitted By (login_id): required (string)
- TOTAL DEFECTS: required (string)
- TOTAL MAJOR: required (number)
- TOTAL MINOR: required (number)
- TOTAL NO. OF PIECES INSPECTED: required (number)
- TOTAL PCS INSPECTED: required (number)
- User: required (string)
- VENDOR NAME: (string)
- WAREHOUSE NAME: required (string)
- created_at: (datetime)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/ware7/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the ware7 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
get /api/ware7/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the ware7 to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
warehouse
Resources in this group are related to warehouse
Returns a list of Warehouse
Create a new warehouse
get /api/warehouse
Returns a list of Warehouse
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/warehouse
Create a new warehouse
Body
Media type: application/json
Type: object
Properties- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a warehouse
Get warehouse by id
Edit an existing warehouse
get /api/warehouse/{referenceId}
Get warehouse by id
URI Parameters
- referenceId: required (string)
Reference id of the warehouse to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/warehouse/{referenceId}
Edit an existing warehouse
URI Parameters
- referenceId: required (string)
Reference id of the warehouse to be fetched
Body
Media type: application/json
Type: object
Properties- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- audit_final_result: required (string)
- brand: required (string)
- category: required (string)
- closed_by: required (boolean)
- closed_on_utc0530: required (boolean)
- col_1st_defect: required (string)
- col_1st_defect_major: required (string)
- col_1st_defect_minor: required (number)
- col_1st_time_audit_result: required (string)
- col_2nd_defct: required (string)
- col_2nd_defect: required (string)
- col_2nd_defect_major: required (string)
- col_2nd_defect_minor: required (string)
- col_2nd_time_audit_result: required (string)
- col_3rd_defect: required (string)
- col_3rd_defect_major: required (number)
- col_3rd_defect_minor: required (boolean)
- col_4th_defect: required (string)
- col_4th_defect_major: required (boolean)
- col_4th_defect_minor: required (boolean)
- col_5th_defect: required (string)
- col_5th_defect_major: required (number)
- col_5th_defect_minor: required (number)
- col_date: required (string)
- col_role: required (string)
- col_user: required (string)
- colors: required (string)
- count_and_image_of_damaged_cartons: required (string)
- created_at: (datetime)
- dhu: required (string)
- due_date: required (boolean)
- employee_id: required (number)
- factory_name: (string)
- field_qa_name: required (string)
- gender: required (string)
- general_remarks: required (string)
- invoice_number: (string)
- invoice_qty: (number)
- level1_by: required (boolean)
- level1_date_utc0530: required (boolean)
- name_of_the_person_approving_the_failed_audit_only_name_in_caps: required (string)
- no_of_boxes_recd: (number)
- notify_jeans_quality_head: required (string)
- notify_knits_quality_head: required (string)
- notify_sbt_quality_head: required (string)
- notify_shirts_quality_head: required (string)
- notify_womenswear_quality_head: required (string)
- product_type: required (string)
- reference_id: (string)
- reference_no: (string)
- rtv: required (string)
- season: required (string)
- store: required (string)
- style_code_caps_on: (string)
- submission_date_utc0530: (datetime)
- submitted_by: required (string)
- submitted_by_login_id: required (string)
- total_defects: required (string)
- total_major: required (string)
- total_minor: required (string)
- total_no_of_pieces_inspected: required (string)
- total_pcs_inspected: required (string)
- updated_at: required (datetime)
- vendor_name: (string)
- version: (number)
- warehouse_name: required (string)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/warehouse/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the warehouse to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
delete /api/warehouse/{referenceId}/usergroup
get /api/warehouse/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the warehouse to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
world
Resources in this group are related to world
Returns a list of World
Create a new world
get /api/world
Returns a list of World
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- default_order: required (number)
- default_permission: (number)
- icon: required (string)
- is_hidden: (boolean)
- is_join_table: (boolean)
- is_state_tracking_enabled: (boolean)
- is_top_level: (boolean)
- reference_id: (string)
- table_name: (string)
- updated_at: required (datetime)
- version: (number)
- world_schema_json: (string)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_column_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/world
Create a new world
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- default_order: required (number)
- default_permission: (number)
- icon: required (string)
- is_hidden: (boolean)
- is_join_table: (boolean)
- is_state_tracking_enabled: (boolean)
- is_top_level: (boolean)
- reference_id: (string)
- table_name: (string)
- updated_at: required (datetime)
- version: (number)
- world_schema_json: (string)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- default_order: required (number)
- default_permission: (number)
- icon: required (string)
- is_hidden: (boolean)
- is_join_table: (boolean)
- is_state_tracking_enabled: (boolean)
- is_top_level: (boolean)
- reference_id: (string)
- table_name: (string)
- updated_at: required (datetime)
- version: (number)
- world_schema_json: (string)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_column_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a world
Get world by id
Edit an existing world
get /api/world/{referenceId}
Get world by id
URI Parameters
- referenceId: required (string)
Reference id of the world to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- default_order: required (number)
- default_permission: (number)
- icon: required (string)
- is_hidden: (boolean)
- is_join_table: (boolean)
- is_state_tracking_enabled: (boolean)
- is_top_level: (boolean)
- reference_id: (string)
- table_name: (string)
- updated_at: required (datetime)
- version: (number)
- world_schema_json: (string)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_column_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/world/{referenceId}
Edit an existing world
URI Parameters
- referenceId: required (string)
Reference id of the world to be fetched
Body
Media type: application/json
Type: object
Properties- created_at: (datetime)
- default_order: required (number)
- default_permission: (number)
- icon: required (string)
- is_hidden: (boolean)
- is_join_table: (boolean)
- is_state_tracking_enabled: (boolean)
- is_top_level: (boolean)
- reference_id: (string)
- table_name: (string)
- updated_at: required (datetime)
- version: (number)
- world_schema_json: (string)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- default_order: required (number)
- default_permission: (number)
- icon: required (string)
- is_hidden: (boolean)
- is_join_table: (boolean)
- is_state_tracking_enabled: (boolean)
- is_top_level: (boolean)
- reference_id: (string)
- table_name: (string)
- updated_at: required (datetime)
- version: (number)
- world_schema_json: (string)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_column_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related action from the parent object
Returns a list of Action
get /api/world/{referenceId}/action
Returns a list of Action
URI Parameters
- referenceId: required (string)
Reference id of the world to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- action_name: (string)
- action_schema: (string)
- created_at: (datetime)
- instance_optional: (boolean)
- label: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related smd from the parent object
Returns a list of Smd
get /api/world/{referenceId}/smd
Returns a list of Smd
URI Parameters
- referenceId: required (string)
Reference id of the world to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- events: (string)
- initial_state: (string)
- label: (string)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related timeline from the parent object
Returns a list of Timeline
get /api/world/{referenceId}/timeline
Returns a list of Timeline
URI Parameters
- referenceId: required (string)
Reference id of the world to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- event_type: (string)
- payload: required (string)
- reference_id: (string)
- title: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related user from the parent object
Returns a list of User
get /api/world/{referenceId}/user
Returns a list of User
URI Parameters
- referenceId: required (string)
Reference id of the world to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- confirmed: (boolean)
- created_at: (datetime)
- email: (string)
- name: (string)
- password: required (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related usergroup from the parent object
Returns a list of Usergroup
get /api/world/{referenceId}/usergroup
Returns a list of Usergroup
URI Parameters
- referenceId: required (string)
Reference id of the world to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- cloud_store_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- data_exchange_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- dev1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- device5_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- devices3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- image_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- instance_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- json_schema_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- marketplace_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_connect_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- oauth_token_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- package_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- payment_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- site_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- stream_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- transaction_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware1_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware3_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware6_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- ware7_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- warehouse_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related world_column from the parent object
Returns a list of World column
delete /api/world/{referenceId}/world_column
get /api/world/{referenceId}/world_column
Returns a list of World column
URI Parameters
- referenceId: required (string)
Reference id of the world to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- column_description: required (string)
- column_name: (string)
- column_type: (string)
- created_at: (datetime)
- data_type: required (string)
- default_value: required (string)
- foreign_key_data: required (string)
- include_in_api: (boolean)
- is_auto_increment: (boolean)
- is_foreign_key: (boolean)
- is_indexed: (boolean)
- is_nullable: (boolean)
- is_primary_key: (boolean)
- is_unique: (boolean)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
world_column
Resources in this group are related to world_column
Returns a list of World column
Create a new world_column
get /api/world_column
Returns a list of World column
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- column_description: required (string)
- column_name: (string)
- column_type: (string)
- created_at: (datetime)
- data_type: required (string)
- default_value: required (string)
- foreign_key_data: required (string)
- include_in_api: (boolean)
- is_auto_increment: (boolean)
- is_foreign_key: (boolean)
- is_indexed: (boolean)
- is_nullable: (boolean)
- is_primary_key: (boolean)
- is_unique: (boolean)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
post /api/world_column
Create a new world_column
Body
Media type: application/json
Type: object
Properties- column_description: required (string)
- column_name: (string)
- column_type: (string)
- created_at: (datetime)
- data_type: required (string)
- default_value: required (string)
- foreign_key_data: required (string)
- include_in_api: (boolean)
- is_auto_increment: (boolean)
- is_foreign_key: (boolean)
- is_indexed: (boolean)
- is_nullable: (boolean)
- is_primary_key: (boolean)
- is_unique: (boolean)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- column_description: required (string)
- column_name: (string)
- column_type: (string)
- created_at: (datetime)
- data_type: required (string)
- default_value: required (string)
- foreign_key_data: required (string)
- include_in_api: (boolean)
- is_auto_increment: (boolean)
- is_foreign_key: (boolean)
- is_indexed: (boolean)
- is_nullable: (boolean)
- is_primary_key: (boolean)
- is_unique: (boolean)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Delete a world_column
Get world_column by id
Edit an existing world_column
get /api/world_column/{referenceId}
Get world_column by id
URI Parameters
- referenceId: required (string)
Reference id of the world_column to be fetched
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- column_description: required (string)
- column_name: (string)
- column_type: (string)
- created_at: (datetime)
- data_type: required (string)
- default_value: required (string)
- foreign_key_data: required (string)
- include_in_api: (boolean)
- is_auto_increment: (boolean)
- is_foreign_key: (boolean)
- is_indexed: (boolean)
- is_nullable: (boolean)
- is_primary_key: (boolean)
- is_unique: (boolean)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
patch /api/world_column/{referenceId}
Edit an existing world_column
URI Parameters
- referenceId: required (string)
Reference id of the world_column to be fetched
Body
Media type: application/json
Type: object
Properties- column_description: required (string)
- column_name: (string)
- column_type: (string)
- created_at: (datetime)
- data_type: required (string)
- default_value: required (string)
- foreign_key_data: required (string)
- include_in_api: (boolean)
- is_auto_increment: (boolean)
- is_foreign_key: (boolean)
- is_indexed: (boolean)
- is_nullable: (boolean)
- is_primary_key: (boolean)
- is_unique: (boolean)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- column_description: required (string)
- column_name: (string)
- column_type: (string)
- created_at: (datetime)
- data_type: required (string)
- default_value: required (string)
- foreign_key_data: required (string)
- include_in_api: (boolean)
- is_auto_increment: (boolean)
- is_foreign_key: (boolean)
- is_indexed: (boolean)
- is_nullable: (boolean)
- is_primary_key: (boolean)
- is_unique: (boolean)
- name: (string)
- reference_id: (string)
- updated_at: required (datetime)
- version: (number)
- id: required (string)
- relationships: required (object)
- world_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)
Remove a related world from the parent object
Returns a list of World
delete /api/world_column/{referenceId}/world
get /api/world_column/{referenceId}/world
Returns a list of World
URI Parameters
- referenceId: required (string)
Reference id of the world_column to be fetched
Query Parameters
- page[number]: (string)
Page number for the query set, starts with 1
- page[size]: (string)
Size of one page, try 10
- query: (string)
search text in indexed columns
- sort: (string)
Field name to sort by
HTTP status code 200
Body
Media type: application/vnd.api+json
Type: object
Properties- data: required (object)
- attributes: required (object)
- created_at: (datetime)
- default_order: required (number)
- default_permission: (number)
- icon: required (string)
- is_hidden: (boolean)
- is_join_table: (boolean)
- is_state_tracking_enabled: (boolean)
- is_top_level: (boolean)
- reference_id: (string)
- table_name: (string)
- updated_at: required (datetime)
- version: (number)
- world_schema_json: (string)
- id: required (string)
- relationships: required (object)
- action_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- smd_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- timeline_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- user_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- usergroup_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- world_column_id: required (object)
- data: required (object)
Associated objects which are also included in the current response
- id: required (string)
Id of the object
- type: required (string)
Type of the included object
- id: required (string)
- links: required (object)
From page
- related: required (string)
link to related objects
- self: required (string)
link to self
- related: required (string)
- data: required (object)
- action_id: required (object)
- type: required (string)
- attributes: required (object)
- links: required (object)
- current_page: required (number)
The current page, for pagination
- from: required (number)
From page
- last_page: required (number)
The last page number in current query set
- per_page: required (number)
This is the number of results in one page
- to: required (number)
Index of the last record feched in this result
- total: required (number)
Total number of records
- current_page: required (number)