Organization Actions

https://api.losant.com/orgs/ORG_ID

Below are the various requests that can be performed against the Organization resource, as well as the expected parameters and the potential responses.

Delete

Deletes an organization

Method And Url

DELETE https://api.losant.com/orgs/ORG_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.Organization.bounded, all.User, all.User.bounded, only.Organization, only.Organization.bounded, org.*, or org.delete.

Request Path Components

Path Component	Description	Example
ORG_ID	ID associated with the organization	575ed6e87ae143cd83dc4aa8

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.losant.com/orgs/ORG_ID

Successful Responses

Code	Type	Description
200	Success	If organization was successfully deleted

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if organization was not found

Device Counts

Returns device counts by day for the time range specified for this organization

Method And Url

GET https://api.losant.com/orgs/ORG_ID/deviceCounts

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, only.Organization, only.Organization.bounded, only.Organization.read, org.*, or org.deviceCounts.

Request Path Components

Path Component	Description	Example
ORG_ID	ID associated with the organization	575ed6e87ae143cd83dc4aa8

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for device count query (ms since epoch)		start=0
end	N	End of range for device count query (ms since epoch)		end=1465790400000

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/orgs/ORG_ID/deviceCounts

Successful Responses

Code	Type	Description
200	Device Counts	Device counts by day

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if organization was not found

Get

Retrieves information on an organization

Method And Url

GET https://api.losant.com/orgs/ORG_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, only.Organization, only.Organization.bounded, only.Organization.read, org.*, or org.get.

Request Path Components

Path Component	Description	Example
ORG_ID	ID associated with the organization	575ed6e87ae143cd83dc4aa8

Request Query Parameters

Name	Required	Description	Default	Example
summaryExclude	N	Comma-separated list of summary fields to exclude from org summary		summaryExclude=payloadCount
summaryInclude	N	Comma-separated list of summary fields to include in org summary		summaryInclude=payloadCount

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/orgs/ORG_ID

Successful Responses

Code	Type	Description
200	Organization	Organization information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if organization not found

Invite Member

Invites a person to an organization

Method And Url

POST https://api.losant.com/orgs/ORG_ID/invites

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.User, only.Organization, org.*, or org.inviteMember.

Request Path Components

Path Component	Description	Example
ORG_ID	ID associated with the organization	575ed6e87ae143cd83dc4aa8

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Organization Invitation Post schema. For example, the following would be a valid body for this request:

{
  "email": "invitedUser@example.com",
  "role": "edit"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"email":"invitedUser@example.com","role":"edit"}' \
    https://api.losant.com/orgs/ORG_ID/invites

Successful Responses

Code	Type	Description
200	Organization Invitations	Invitation information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if organization not found

Modify Member

Modifies a current org member's role

Method And Url

PATCH https://api.losant.com/orgs/ORG_ID/member

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.User, only.Organization, org.*, or org.modifyMember.

Request Path Components

Path Component	Description	Example
ORG_ID	ID associated with the organization	575ed6e87ae143cd83dc4aa8

Request Query Parameters

Name	Required	Description	Default	Example
summaryExclude	N	Comma-separated list of summary fields to exclude from org summary		summaryExclude=payloadCount
summaryInclude	N	Comma-separated list of summary fields to include in org summary		summaryInclude=payloadCount

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Organization Member Patch schema. For example, the following would be a valid body for this request:

{
  "userId": "575ef90f7ae143cd83dc4aad",
  "role": "view"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"userId":"575ef90f7ae143cd83dc4aad","role":"view"}' \
    https://api.losant.com/orgs/ORG_ID/member

Successful Responses

Code	Type	Description
200	Organization	Updated organization information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if organization not found

Notebook Minute Counts

Returns notebook execution usage by day for the time range specified for this organization

Method And Url

GET https://api.losant.com/orgs/ORG_ID/notebookMinuteCounts

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, only.Organization, only.Organization.bounded, only.Organization.read, org.*, or org.notebookMinuteCounts.

Request Path Components

Path Component	Description	Example
ORG_ID	ID associated with the organization	575ed6e87ae143cd83dc4aa8

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for notebook execution query (ms since epoch)		start=0
end	N	End of range for notebook execution query (ms since epoch)		end=1465790400000

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/orgs/ORG_ID/notebookMinuteCounts

Successful Responses

Code	Type	Description
200	Notebook Minute Counts	Notebook usage information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if organization was not found

Patch

Updates information about an organization

Method And Url

PATCH https://api.losant.com/orgs/ORG_ID

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.Organization.bounded, all.User, all.User.bounded, only.Organization, only.Organization.bounded, org.*, or org.patch.

Request Path Components

Path Component	Description	Example
ORG_ID	ID associated with the organization	575ed6e87ae143cd83dc4aa8

Request Query Parameters

Name	Required	Description	Default	Example
summaryExclude	N	Comma-separated list of summary fields to exclude from org summary		summaryExclude=payloadCount
summaryInclude	N	Comma-separated list of summary fields to include in org summary		summaryInclude=payloadCount

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Organization Patch schema. For example, the following would be a valid body for this request:

{
  "name": "My Updated Organization",
  "description": "Description of my updated organization"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"name":"My Updated Organization","description":"Description of my updated organization"}' \
    https://api.losant.com/orgs/ORG_ID

Successful Responses

Code	Type	Description
200	Organization	Updated organization information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if organization was not found

Payload Counts

Returns payload counts for the time range specified for all applications this organization owns

Method And Url

GET https://api.losant.com/orgs/ORG_ID/payloadCounts

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, only.Organization, only.Organization.bounded, only.Organization.read, org.*, or org.payloadCounts.

Request Path Components

Path Component	Description	Example
ORG_ID	ID associated with the organization	575ed6e87ae143cd83dc4aa8

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for payload count query (ms since epoch)		start=0
end	N	End of range for payload count query (ms since epoch)		end=1465790400000
asBytes	N	If the resulting stats should be returned as bytes	false	asBytes=true

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/orgs/ORG_ID/payloadCounts

Successful Responses

Code	Type	Description
200	Payload Stats	Payload counts, by type and source

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if organization was not found

Payload Counts Breakdown

Returns payload counts per resolution in the time range specified for all applications this organization owns

Method And Url

GET https://api.losant.com/orgs/ORG_ID/payloadCountsBreakdown

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, only.Organization, only.Organization.bounded, only.Organization.read, org.*, or org.payloadCountsBreakdown.

Request Path Components

Path Component	Description	Example
ORG_ID	ID associated with the organization	575ed6e87ae143cd83dc4aa8

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for payload count query (ms since epoch)		start=0
end	N	End of range for payload count query (ms since epoch)		end=1465790400000
resolution	N	Resolution in milliseconds. Accepted values are: 86400000, 3600000	86400000	resolution=86400000
asBytes	N	If the resulting stats should be returned as bytes	false	asBytes=true
includeNonBillable	N	If non-billable payloads should be included in the result	false	includeNonBillable=true

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/orgs/ORG_ID/payloadCountsBreakdown

Successful Responses

Code	Type	Description
200	Payload Counts Breakdown	Sum of payload counts by date

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if organization was not found

Pending Invites

Gets the current pending invites

Method And Url

GET https://api.losant.com/orgs/ORG_ID/invites

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, only.Organization, only.Organization.bounded, only.Organization.read, org.*, or org.pendingInvites.

Request Path Components

Path Component	Description	Example
ORG_ID	ID associated with the organization	575ed6e87ae143cd83dc4aa8

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/orgs/ORG_ID/invites

Successful Responses

Code	Type	Description
200	Organization Invitations	Invitation information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if organization not found

Remove Member

Removes a member from the org

Method And Url

DELETE https://api.losant.com/orgs/ORG_ID/member

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.User, only.Organization, org.*, or org.removeMember.

Request Path Components

Path Component	Description	Example
ORG_ID	ID associated with the organization	575ed6e87ae143cd83dc4aa8

Request Query Parameters

Name	Required	Description	Default	Example
userId	Y	Id of user to remove		userId=575ed70c7ae143cd83dc4aa9
summaryExclude	N	Comma-separated list of summary fields to exclude from org summary		summaryExclude=payloadCount
summaryInclude	N	Comma-separated list of summary fields to include in org summary		summaryInclude=payloadCount

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.losant.com/orgs/ORG_ID/member?userId=575ed70c7ae143cd83dc4aa9

Successful Responses

Code	Type	Description
200	Organization	Updated organization information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if organization not found

Revoke Invite

Revokes an existing invite

Method And Url

DELETE https://api.losant.com/orgs/ORG_ID/invites

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.User, only.Organization, org.*, or org.revokeInvite.

Request Path Components

Path Component	Description	Example
ORG_ID	ID associated with the organization	575ed6e87ae143cd83dc4aa8

Request Query Parameters

Name	Required	Description	Default	Example
inviteId	Y	Id of invite to revoke		inviteId=575ed71e7ae143cd83dc4aaa

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X DELETE \
    https://api.losant.com/orgs/ORG_ID/invites?inviteId=575ed71e7ae143cd83dc4aaa

Successful Responses

Code	Type	Description
200	Organization Invitations	Invitation information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if organization not found

Transfer Resources

Moves resources to a new owner

Method And Url

PATCH https://api.losant.com/orgs/ORG_ID/transferResources

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.User, only.Organization, org.*, or org.transferResources.

Request Path Components

Path Component	Description	Example
ORG_ID	ID associated with the organization	575ed6e87ae143cd83dc4aa8

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Resource Transfer schema. For example, the following would be a valid body for this request:

{
  "destinationId": "575ed6e87ae143cd83dc4aa8",
  "destinationType": "organization",
  "applicationIds": [
    "575ec8687ae143cd83dc4a97"
  ]
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"destinationId":"575ed6e87ae143cd83dc4aa8","destinationType":"organization","applicationIds":["575ec8687ae143cd83dc4a97"]}' \
    https://api.losant.com/orgs/ORG_ID/transferResources

Successful Responses

Code	Type	Description
200	Success	If resource transfer was successful

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if organization was not found

Schemas

Device Counts

Schema for the result of a device counts request

Device Counts Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
counts:{} 2 keys

Device Counts Example

▶
(root){} 3 keys
start:"1999-05-20T05:00:00.000Z"
end:"1999-06-20T04:59:59.999Z"
▶
counts:[] 1 item

Error

Schema for errors returned by the API

Error Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
type:{} 1 key
▶
message:{} 1 key
▶
validationErrors:{} 2 keys

Error Example

▶
(root){} 2 keys
type:"NotFound"
message:"Application was not found"

Notebook Minute Counts

Schema for the result of a notebook minute counts request

Notebook Minute Counts Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
counts:{} 2 keys

Notebook Minute Counts Example

▶
(root){} 3 keys
start:"1999-05-20T05:00:00.000Z"
end:"1999-06-20T04:59:59.999Z"
▶
counts:[] 1 item

Organization

Schema for a single Organization

Organization Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 23 keys
▶
id:{} 2 keys
▶
orgId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
_currentRole:{} 2 keys
▶
members:{} 2 keys
▶
limits:{} 3 keys
▶
summary:{} 2 keys
▶
planId:{} 2 keys
▶
billingEmail:{} 3 keys
▶
subscriptionStatus:{} 2 keys
▶
currentPeriodStart:{} 2 keys
▶
currentPeriodEnd:{} 2 keys
▶
isEnterprise:{} 1 key
▶
iconColor:{} 2 keys
▶
whitelistedEmailDomains:{} 2 keys
▶
auditLogEnabled:{} 1 key
▶
disabledAt:{} 1 key
▶
isReadOnly:{} 1 key
▶
mfaMode:{} 2 keys
▶
banner:{} 3 keys

Organization Example

▶
(root){} 8 keys
id:"575ed6e87ae143cd83dc4aa8"
orgId:"575ed6e87ae143cd83dc4aa8"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
name:"My Organization"
description:"My organization description"
▶
members:[] 2 items
▶
summary:{} 7 keys

Organization Invitation Post

Schema for the body of a request to send an invitation

Organization Invitation Post Schema

▶
(root){} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys
▶
email:{} 3 keys
▶
role:{} 2 keys
▶
applicationRoles:{} 3 keys
▶
dashboardRoles:{} 3 keys
▶
disallowTransfer:{} 1 key
additionalProperties:false
▶
required:[] 2 items

Organization Invitation Post Example

▶
(root){} 2 keys
email:"invitedUser@example.com"
role:"edit"

Organization Invitations

Schema for an array of pending invitations to an Organization

Organization Invitations Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"array"
▶
items:{} 2 keys

Organization Invitations Example

▶
(root)[] 1 item
▶
0:{} 9 keys

Organization Member Patch

Schema for the body of a request to modify an Organization member

Organization Member Patch Schema

▶
(root){} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 4 keys
▶
userId:{} 2 keys
▶
role:{} 2 keys
▶
applicationRoles:{} 3 keys
▶
dashboardRoles:{} 3 keys
additionalProperties:false
▶
required:[] 1 item

Organization Member Patch Example

▶
(root){} 2 keys
userId:"575ef90f7ae143cd83dc4aad"
role:"view"

Organization Patch

Schema for the body of an Organization modification request

Organization Patch Schema

▶
(root){} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 7 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
planId:{} 2 keys
▶
billingEmail:{} 3 keys
▶
cardToken:{} 2 keys
▶
iconColor:{} 2 keys
▶
mfaMode:{} 2 keys
additionalProperties:false

Organization Patch Example

▶
(root){} 2 keys
name:"My Updated Organization"
description:"Description of my updated organization"

Payload Counts Breakdown

Schema for the result of a payload counts breakdown request

Payload Counts Breakdown Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
counts:{} 2 keys

Payload Counts Breakdown Example

▶
(root){} 3 keys
start:"1999-05-20T05:00:00.000Z"
end:"1999-06-20T04:59:59.999Z"
▶
counts:[] 1 item

Payload Stats

Schema for the result of a payload stats request

Payload Stats Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 19 keys
▶
appFile:{} 2 keys
▶
dataTable:{} 2 keys
▶
deviceCreate:{} 2 keys
▶
deviceCommand:{} 2 keys
▶
deviceConnect:{} 2 keys
▶
deviceDisconnect:{} 2 keys
▶
deviceState:{} 2 keys
▶
endpoint:{} 2 keys
▶
event:{} 2 keys
▶
flowError:{} 2 keys
▶
inboundEmail:{} 2 keys
▶
integration:{} 2 keys
▶
mqttIn:{} 2 keys
▶
mqttOut:{} 2 keys
▶
notebook:{} 2 keys
▶
resourceJob:{} 2 keys
▶
timer:{} 2 keys
▶
virtualButton:{} 2 keys
▶
webhook:{} 2 keys

Payload Stats Example

▶
(root){} 6 keys
▶
timer:{} 1 key
▶
deviceState:{} 2 keys
▶
mqttOut:{} 1 key
▶
webhook:{} 1 key
▶
deviceConnect:{} 1 key
▶
deviceDisconnect:{} 1 key

Resource Transfer

Schema for the body of a resource transfer request

Resource Transfer Schema

▶
(root){} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys
▶
destinationId:{} 2 keys
▶
destinationType:{} 2 keys
▶
applicationIds:{} 3 keys
▶
dashboardIds:{} 3 keys
▶
strict:{} 1 key
additionalProperties:false
▶
required:[] 2 items

Resource Transfer Example

▶
(root){} 3 keys
destinationId:"575ed6e87ae143cd83dc4aa8"
destinationType:"organization"
▶
applicationIds:[] 1 item

Success

Schema for reporting a successful operation

Success Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key
▶
success:{} 2 keys

Success Example

▶
(root){} 1 key
success:true