このページには、独自のアプリケーション内の4DLink機能にアクセスして自動化するためのサンプルAPI呼び出しが含まれています。
SDKクライアントIDとシークレットを取得するには、4dlinkアカウントにアクセスしてください API integration page, 次に、以下のサンプルJSコードを試してください。
サンプルコードについては、ここをクリックしてください。 CodePenでお試しください
APIを介して4DLink地理空間プラットフォームにアクセスして自動化する
Version: 0.9.6.5
BasePath: https://app.4dlink.com
All rights reserved
Access
- OAuth AuthorizationUrl: https://app.4dlink.com/access/token
[ Jump to
Models ]
Table of Contents
Up
delete /api/Account/{id}
(deleteAccount)
Deletes active Account
Path parameters
id (required)
Path Parameter — id format: int64
Responses
200
Success
403
Access denied
(findAccount)
Searchs Accounts
Query parameters
limit (optional)
Query Parameter — Limit results to this number (if no supplied 100)
sortby (optional)
Query Parameter — Name of concrete column to sort results by
sortbyorder (optional)
Query Parameter — Sort direction (down by default)
Return type
Example data
Content-Type: application/json
{
"total" : 5,
"offset" : 2,
"payload" : [ {
"active" : "active",
"isDomain" : "isDomain",
"dateUpdated" : 1,
"uid" : "uid",
"uploadClients" : "uploadClients",
"dateMade" : 0,
"trialEndDate" : 5,
"name" : "name",
"json" : { },
"closed" : "closed",
"id" : 6,
"accountGroups" : "accountGroups",
"invitedUsers" : "invitedUsers",
"desc" : "desc"
}, {
"active" : "active",
"isDomain" : "isDomain",
"dateUpdated" : 1,
"uid" : "uid",
"uploadClients" : "uploadClients",
"dateMade" : 0,
"trialEndDate" : 5,
"name" : "name",
"json" : { },
"closed" : "closed",
"id" : 6,
"accountGroups" : "accountGroups",
"invitedUsers" : "invitedUsers",
"desc" : "desc"
} ],
"time" : 1589152904322,
"message" : "OK",
"rows" : 7,
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_8
403
Access denied
(getAccount)
Creates a new Account
Path parameters
id (required)
Path Parameter — id format: int64
Return type
Example data
Content-Type: application/json
{
"payload" : {
"active" : "active",
"isDomain" : "isDomain",
"dateUpdated" : 1,
"uid" : "uid",
"uploadClients" : "uploadClients",
"dateMade" : 0,
"trialEndDate" : 5,
"name" : "name",
"json" : { },
"closed" : "closed",
"id" : 6,
"accountGroups" : "accountGroups",
"invitedUsers" : "invitedUsers",
"desc" : "desc"
},
"time" : 1589152904322,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_9
403
Access denied
(makeAccount)
Creates a new Account
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"payload" : {
"active" : "active",
"isDomain" : "isDomain",
"dateUpdated" : 1,
"uid" : "uid",
"uploadClients" : "uploadClients",
"dateMade" : 0,
"trialEndDate" : 5,
"name" : "name",
"json" : { },
"closed" : "closed",
"id" : 6,
"accountGroups" : "accountGroups",
"invitedUsers" : "invitedUsers",
"desc" : "desc"
},
"time" : 1589152904322,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_9
403
Access denied
(updateAccount)
Updates active Account
Path parameters
id (required)
Path Parameter — id format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"payload" : {
"active" : "active",
"isDomain" : "isDomain",
"dateUpdated" : 1,
"uid" : "uid",
"uploadClients" : "uploadClients",
"dateMade" : 0,
"trialEndDate" : 5,
"name" : "name",
"json" : { },
"closed" : "closed",
"id" : 6,
"accountGroups" : "accountGroups",
"invitedUsers" : "invitedUsers",
"desc" : "desc"
},
"time" : 1589152904322,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_9
403
Access denied
Up
delete /api/Annotation/{id}
(deleteAnnotation)
Deletes active Annotation
Path parameters
id (required)
Path Parameter — id format: int64
Responses
200
Success
403
Access denied
Up
get /api/Annotation/{id}
(getAnnotation)
Creates a new Annotation
Path parameters
id (required)
Path Parameter — id format: int64
Return type
Example data
Content-Type: application/json
{
"payload" : {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"tags" : "tags",
"dateUpdated" : 5,
"uid" : "uid",
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc"
},
"time" : 1589152904309,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_23
403
Access denied
Up
put /api/Annotation/{id}
(updateAnnotation)
Updates active Annotation
Path parameters
id (required)
Path Parameter — id format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"payload" : {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"tags" : "tags",
"dateUpdated" : 5,
"uid" : "uid",
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc"
},
"time" : 1589152904309,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_23
403
Access denied
Up
delete /api/Dataset/{id}
(deleteDataset)
Deletes active Dataset
Path parameters
id (required)
Path Parameter — id format: int64
Responses
200
Success
403
Access denied
Up
get /api/Dataset/{id}/data
(downloadBinDS)
Download the binary of this dataset
Path parameters
id (required)
Path Parameter — id format: int64
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
403
Access denied
(findDataset)
Searchs Datasets
Query parameters
limit (optional)
Query Parameter — Limit results to this number (if no supplied 100)
sortby (optional)
Query Parameter — Name of concrete column to sort results by
sortbyorder (optional)
Query Parameter — Sort direction (down by default)
Return type
Example data
Content-Type: application/json
{
"total" : 0,
"offset" : 6,
"payload" : [ {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"dateUpdated" : 5,
"initParams" : { },
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc",
"status" : "status"
}, {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"dateUpdated" : 5,
"initParams" : { },
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc",
"status" : "status"
} ],
"time" : 1589152904307,
"message" : "OK",
"rows" : 1,
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_18
403
Access denied
(getDataset)
Creates a new Dataset
Path parameters
id (required)
Path Parameter — id format: int64
Return type
Example data
Content-Type: application/json
{
"payload" : {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"dateUpdated" : 5,
"initParams" : { },
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc",
"status" : "status"
},
"time" : 1589152904307,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_13
403
Access denied
(makeDataset)
Creates a new Dataset
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"payload" : {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"dateUpdated" : 5,
"initParams" : { },
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc",
"status" : "status"
},
"time" : 1589152904307,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_13
403
Access denied
Up
post /api/Dataset/{id}/process/{xformId}
(postDataset)
Starts a transform on a dataset
Path parameters
id (required)
Path Parameter — id format: int64
xformId (required)
Path Parameter — ID of transform type
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"time" : 1589152904307,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_12
403
Access denied
Up
post /api/Dataset/{id}.chunked/data
(postDatasetUpload)
Starts or resumes the binary upload for a dataset. A dataset must be created using the POST /api/Dataset endpoint prior to this step
Path parameters
id (required)
Path Parameter — id format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
body (required)
Body Parameter —
Query parameters
seq (required)
Query Parameter — Sequence number for this chunk (starting at zero) format: int64
offset (required)
Query Parameter — Offset in bytes of this chunk format: int64
length (required)
Query Parameter — Total length of the upload (not the length of this chunk) format: int64
chunk (required)
Query Parameter — Length of the current chunk (not the length of the entire file) format: int64
last (required)
Query Parameter — Signify if this is the last chunk
Return type
Example data
Content-Type: application/json
{
"time" : 1589152904307,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_12
403
Access denied
(updateDataset)
Updates active Dataset
Path parameters
id (required)
Path Parameter — id format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"payload" : {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"dateUpdated" : 5,
"initParams" : { },
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc",
"status" : "status"
},
"time" : 1589152904307,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_13
403
Access denied
Up
delete /api/Folder/{id}
(deleteFolder)
Deletes active Folder
Path parameters
id (required)
Path Parameter — id format: int64
Responses
200
Success
403
Access denied
(findFolder)
Searchs Folders
Query parameters
limit (optional)
Query Parameter — Limit results to this number (if no supplied 100)
sortby (optional)
Query Parameter — Name of concrete column to sort results by
sortbyorder (optional)
Query Parameter — Sort direction (down by default)
Return type
Example data
Content-Type: application/json
{
"total" : 5,
"offset" : 5,
"payload" : [ {
"plotable" : "plotable",
"icon" : "icon",
"active" : "active",
"dateUpdated" : 1,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"desc" : "desc"
}, {
"plotable" : "plotable",
"icon" : "icon",
"active" : "active",
"dateUpdated" : 1,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"desc" : "desc"
} ],
"time" : 1589152904307,
"message" : "OK",
"rows" : 2,
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_5
403
Access denied
(getFolder)
Creates a new Folder
Path parameters
id (required)
Path Parameter — id format: int64
Return type
Example data
Content-Type: application/json
{
"payload" : {
"plotable" : "plotable",
"icon" : "icon",
"active" : "active",
"dateUpdated" : 1,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"desc" : "desc"
},
"time" : 1589152904307,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_6
403
Access denied
(makeFolder)
Creates a new Folder
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"payload" : {
"plotable" : "plotable",
"icon" : "icon",
"active" : "active",
"dateUpdated" : 1,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"desc" : "desc"
},
"time" : 1589152904307,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_6
403
Access denied
(updateFolder)
Updates active Folder
Path parameters
id (required)
Path Parameter — id format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"payload" : {
"plotable" : "plotable",
"icon" : "icon",
"active" : "active",
"dateUpdated" : 1,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"desc" : "desc"
},
"time" : 1589152904307,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_6
403
Access denied
(deleteJob)
Deletes active Job
Path parameters
id (required)
Path Parameter — id format: int64
Responses
200
Success
403
Access denied
Up
get /api/Job/{id}.inputDatasets
(findDatasetinputDatasets)
Searchs Datasets
Path parameters
id (required)
Path Parameter — id format: int64
Query parameters
limit (optional)
Query Parameter — Limit results to this number (if no supplied 100)
sortby (optional)
Query Parameter — Name of concrete column to sort results by
sortbyorder (optional)
Query Parameter — Sort direction (down by default)
Return type
Example data
Content-Type: application/json
{
"total" : 0,
"offset" : 6,
"payload" : [ {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"dateUpdated" : 5,
"initParams" : { },
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc",
"status" : "status"
}, {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"dateUpdated" : 5,
"initParams" : { },
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc",
"status" : "status"
} ],
"time" : 1589152904311,
"message" : "OK",
"rows" : 1,
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_24
403
Access denied
Up
get /api/Job/{id}.inputFolders
(findFolderinputFolders)
Searchs Folders
Path parameters
id (required)
Path Parameter — id format: int64
Query parameters
limit (optional)
Query Parameter — Limit results to this number (if no supplied 100)
sortby (optional)
Query Parameter — Name of concrete column to sort results by
sortbyorder (optional)
Query Parameter — Sort direction (down by default)
Return type
Example data
Content-Type: application/json
{
"total" : 0,
"offset" : 6,
"payload" : [ {
"plotable" : "plotable",
"icon" : "icon",
"active" : "active",
"dateUpdated" : 1,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"desc" : "desc"
}, {
"plotable" : "plotable",
"icon" : "icon",
"active" : "active",
"dateUpdated" : 1,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"desc" : "desc"
} ],
"time" : 1589152904311,
"message" : "OK",
"rows" : 1,
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_19
403
Access denied
(findJob)
Searchs Jobs
Query parameters
limit (optional)
Query Parameter — Limit results to this number (if no supplied 100)
sortby (optional)
Query Parameter — Name of concrete column to sort results by
sortbyorder (optional)
Query Parameter — Sort direction (down by default)
Return type
Example data
Content-Type: application/json
{
"total" : 5,
"offset" : 5,
"payload" : [ {
"active" : "active",
"inputFolders" : "inputFolders",
"dateUpdated" : 1,
"dateMade" : 0,
"name" : "name",
"json" : { },
"inputDatasets" : "inputDatasets",
"id" : 6,
"emailOnFinish" : "emailOnFinish",
"desc" : "desc",
"status" : "status"
}, {
"active" : "active",
"inputFolders" : "inputFolders",
"dateUpdated" : 1,
"dateMade" : 0,
"name" : "name",
"json" : { },
"inputDatasets" : "inputDatasets",
"id" : 6,
"emailOnFinish" : "emailOnFinish",
"desc" : "desc",
"status" : "status"
} ],
"time" : 1589152904311,
"message" : "OK",
"rows" : 2,
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_15
403
Access denied
(getJob)
Creates a new Job
Path parameters
id (required)
Path Parameter — id format: int64
Return type
Example data
Content-Type: application/json
{
"payload" : {
"active" : "active",
"inputFolders" : "inputFolders",
"dateUpdated" : 1,
"dateMade" : 0,
"name" : "name",
"json" : { },
"inputDatasets" : "inputDatasets",
"id" : 6,
"emailOnFinish" : "emailOnFinish",
"desc" : "desc",
"status" : "status"
},
"time" : 1589152904311,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_16
403
Access denied
Up
delete /api/Job/{id}.inputDatasets/{relId}
(getJobInputDatasetsDel)
Remove association to record Job's inputDatasets
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Responses
200
Association added
403
Access denied
Up
post /api/Job/{id}.inputDatasets/{relId}
(getJobInputDatasetsPut)
Adds new association to record Job's inputDatasets
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
Association added
403
Access denied
Up
delete /api/Job/{id}.inputFolders/{relId}
(getJobInputFoldersDel)
Remove association to record Job's inputFolders
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Responses
200
Association added
403
Access denied
Up
post /api/Job/{id}.inputFolders/{relId}
(getJobInputFoldersPut)
Adds new association to record Job's inputFolders
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
Association added
403
Access denied
(makeJob)
Creates a new Job
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"payload" : {
"active" : "active",
"inputFolders" : "inputFolders",
"dateUpdated" : 1,
"dateMade" : 0,
"name" : "name",
"json" : { },
"inputDatasets" : "inputDatasets",
"id" : 6,
"emailOnFinish" : "emailOnFinish",
"desc" : "desc",
"status" : "status"
},
"time" : 1589152904311,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_16
403
Access denied
(updateJob)
Updates active Job
Path parameters
id (required)
Path Parameter — id format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"payload" : {
"active" : "active",
"inputFolders" : "inputFolders",
"dateUpdated" : 1,
"dateMade" : 0,
"name" : "name",
"json" : { },
"inputDatasets" : "inputDatasets",
"id" : 6,
"emailOnFinish" : "emailOnFinish",
"desc" : "desc",
"status" : "status"
},
"time" : 1589152904311,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_16
403
Access denied
Up
delete /api/JobBatch/{id}
(deleteJobBatch)
Deletes active JobBatch
Path parameters
id (required)
Path Parameter — id format: int64
Responses
200
Success
403
Access denied
Up
get /api/JobBatch/{id}.outputs
(findDatasetoutputs)
Searchs Datasets
Path parameters
id (required)
Path Parameter — id format: int64
Query parameters
limit (optional)
Query Parameter — Limit results to this number (if no supplied 100)
sortby (optional)
Query Parameter — Name of concrete column to sort results by
sortbyorder (optional)
Query Parameter — Sort direction (down by default)
Return type
Example data
Content-Type: application/json
{
"total" : 5,
"offset" : 2,
"payload" : [ {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"dateUpdated" : 5,
"initParams" : { },
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc",
"status" : "status"
}, {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"dateUpdated" : 5,
"initParams" : { },
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc",
"status" : "status"
} ],
"time" : 1589152904306,
"message" : "OK",
"rows" : 7,
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_7
403
Access denied
Up
get /api/JobBatch/{id}
(getJobBatch)
Creates a new JobBatch
Path parameters
id (required)
Path Parameter — id format: int64
Return type
Example data
Content-Type: application/json
{
"payload" : { },
"time" : 1589152904305,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_22
403
Access denied
Up
delete /api/JobBatch/{id}.outputs/{relId}
(getJobBatchOutputsDel)
Remove association to record JobBatch's outputs
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Responses
200
Association added
403
Access denied
Up
post /api/JobBatch/{id}.outputs/{relId}
(getJobBatchOutputsPut)
Adds new association to record JobBatch's outputs
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
Association added
403
Access denied
Up
put /api/JobBatch/{id}
(updateJobBatch)
Updates active JobBatch
Path parameters
id (required)
Path Parameter — id format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"payload" : { },
"time" : 1589152904305,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_22
403
Access denied
Up
delete /api/Project/{id}
(deleteProject)
Deletes active Project
Path parameters
id (required)
Path Parameter — id format: int64
Responses
200
Success
403
Access denied
Up
get /api/Project/{id}.shareClients
(findClientshareClients)
Searchs Clients
Path parameters
id (required)
Path Parameter — id format: int64
Query parameters
limit (optional)
Query Parameter — Limit results to this number (if no supplied 100)
sortby (optional)
Query Parameter — Name of concrete column to sort results by
sortbyorder (optional)
Query Parameter — Sort direction (down by default)
Return type
Example data
Content-Type: application/json
{
"total" : 0,
"offset" : 6,
"payload" : [ { }, { } ],
"time" : 1589152904315,
"message" : "OK",
"rows" : 1,
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_17
403
Access denied
Up
get /api/Project/{id}.folders
(findFolderfolders)
Searchs Folders
Path parameters
id (required)
Path Parameter — id format: int64
Query parameters
limit (optional)
Query Parameter — Limit results to this number (if no supplied 100)
sortby (optional)
Query Parameter — Name of concrete column to sort results by
sortbyorder (optional)
Query Parameter — Sort direction (down by default)
Return type
Example data
Content-Type: application/json
{
"total" : 0,
"offset" : 6,
"payload" : [ {
"plotable" : "plotable",
"icon" : "icon",
"active" : "active",
"dateUpdated" : 1,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"desc" : "desc"
}, {
"plotable" : "plotable",
"icon" : "icon",
"active" : "active",
"dateUpdated" : 1,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"desc" : "desc"
} ],
"time" : 1589152904314,
"message" : "OK",
"rows" : 1,
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_10
403
Access denied
(findProject)
Searchs Projects
Query parameters
limit (optional)
Query Parameter — Limit results to this number (if no supplied 100)
sortby (optional)
Query Parameter — Name of concrete column to sort results by
sortbyorder (optional)
Query Parameter — Sort direction (down by default)
Return type
Example data
Content-Type: application/json
{
"total" : 5,
"offset" : 2,
"payload" : [ {
"llat" : "llat",
"folders" : "folders",
"ulng" : "ulng",
"shareUsers" : "shareUsers",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"datasets" : "datasets",
"uheight" : "uheight",
"tags" : "tags",
"dateUpdated" : 5,
"uid" : "uid",
"dateMade" : 0,
"shareClients" : "shareClients",
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc"
}, {
"llat" : "llat",
"folders" : "folders",
"ulng" : "ulng",
"shareUsers" : "shareUsers",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"datasets" : "datasets",
"uheight" : "uheight",
"tags" : "tags",
"dateUpdated" : 5,
"uid" : "uid",
"dateMade" : 0,
"shareClients" : "shareClients",
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc"
} ],
"time" : 1589152904313,
"message" : "OK",
"rows" : 7,
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_3
403
Access denied
Up
get /api/Project/{id}.shareUsers
(findUsershareUsers)
Searchs Users
Path parameters
id (required)
Path Parameter — id format: int64
Query parameters
limit (optional)
Query Parameter — Limit results to this number (if no supplied 100)
sortby (optional)
Query Parameter — Name of concrete column to sort results by
sortbyorder (optional)
Query Parameter — Sort direction (down by default)
Return type
Example data
Content-Type: application/json
{
"total" : 0,
"offset" : 6,
"payload" : [ { }, { } ],
"time" : 1589152904314,
"message" : "OK",
"rows" : 1,
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_14
403
Access denied
(getProject)
Creates a new Project
Path parameters
id (required)
Path Parameter — id format: int64
Return type
Example data
Content-Type: application/json
{
"payload" : {
"llat" : "llat",
"folders" : "folders",
"ulng" : "ulng",
"shareUsers" : "shareUsers",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"datasets" : "datasets",
"uheight" : "uheight",
"tags" : "tags",
"dateUpdated" : 5,
"uid" : "uid",
"dateMade" : 0,
"shareClients" : "shareClients",
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc"
},
"time" : 1589152904313,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_4
403
Access denied
Up
delete /api/Project/{id}.shareClients/{relId}
(getProjectShareClientsDel)
Remove association to record Project's shareClients
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Responses
200
Association added
403
Access denied
Up
post /api/Project/{id}.shareClients/{relId}
(getProjectShareClientsPut)
Adds new association to record Project's shareClients
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
Association added
403
Access denied
Up
delete /api/Project/{id}.shareUsers/{relId}
(getProjectShareUsersDel)
Remove association to record Project's shareUsers
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Responses
200
Association added
403
Access denied
Up
post /api/Project/{id}.shareUsers/{relId}
(getProjectShareUsersPut)
Adds new association to record Project's shareUsers
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
Association added
403
Access denied
(makeProject)
Creates a new Project
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"payload" : {
"llat" : "llat",
"folders" : "folders",
"ulng" : "ulng",
"shareUsers" : "shareUsers",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"datasets" : "datasets",
"uheight" : "uheight",
"tags" : "tags",
"dateUpdated" : 5,
"uid" : "uid",
"dateMade" : 0,
"shareClients" : "shareClients",
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc"
},
"time" : 1589152904313,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_4
403
Access denied
(updateProject)
Updates active Project
Path parameters
id (required)
Path Parameter — id format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"payload" : {
"llat" : "llat",
"folders" : "folders",
"ulng" : "ulng",
"shareUsers" : "shareUsers",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"datasets" : "datasets",
"uheight" : "uheight",
"tags" : "tags",
"dateUpdated" : 5,
"uid" : "uid",
"dateMade" : 0,
"shareClients" : "shareClients",
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"seq" : 1,
"desc" : "desc"
},
"time" : 1589152904313,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_4
403
Access denied
(findTransform)
Searchs Transforms
Query parameters
limit (optional)
Query Parameter — Limit results to this number (if no supplied 100)
sortby (optional)
Query Parameter — Name of concrete column to sort results by
sortbyorder (optional)
Query Parameter — Sort direction (down by default)
Return type
Example data
Content-Type: application/json
{
"total" : 0,
"offset" : 6,
"payload" : [ {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"tags" : "tags",
"dateUpdated" : 5,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"emailOnFinish" : "emailOnFinish",
"seq" : 1,
"desc" : "desc",
"status" : "status"
}, {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"tags" : "tags",
"dateUpdated" : 5,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"emailOnFinish" : "emailOnFinish",
"seq" : 1,
"desc" : "desc",
"status" : "status"
} ],
"time" : 1589152904308,
"message" : "OK",
"rows" : 1,
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_20
403
Access denied
(makeTransform)
Creates a new Transform
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"payload" : {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"tags" : "tags",
"dateUpdated" : 5,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"emailOnFinish" : "emailOnFinish",
"seq" : 1,
"desc" : "desc",
"status" : "status"
},
"time" : 1589152904308,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_21
403
Access denied
Up
get /api/TransformGroup
(findTransformGroup)
Searchs TransformGroups
Query parameters
limit (optional)
Query Parameter — Limit results to this number (if no supplied 100)
sortby (optional)
Query Parameter — Name of concrete column to sort results by
sortbyorder (optional)
Query Parameter — Sort direction (down by default)
Return type
Example data
Content-Type: application/json
{
"total" : 5,
"offset" : 5,
"payload" : [ {
"active" : "active",
"photos" : "photos",
"tags" : "tags",
"dateUpdated" : 1,
"dateMade" : 0,
"children" : "children",
"name" : "name",
"json" : { },
"id" : 6,
"desc" : "desc",
"status" : "status"
}, {
"active" : "active",
"photos" : "photos",
"tags" : "tags",
"dateUpdated" : 1,
"dateMade" : 0,
"children" : "children",
"name" : "name",
"json" : { },
"id" : 6,
"desc" : "desc",
"status" : "status"
} ],
"time" : 1589152904320,
"message" : "OK",
"rows" : 2,
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_1
403
Access denied
Up
get /api/TransformGroup/{id}.children
(findTransformchildren)
Searchs Transforms
Path parameters
id (required)
Path Parameter — id format: int64
Query parameters
limit (optional)
Query Parameter — Limit results to this number (if no supplied 100)
sortby (optional)
Query Parameter — Name of concrete column to sort results by
sortbyorder (optional)
Query Parameter — Sort direction (down by default)
Return type
Example data
Content-Type: application/json
{
"total" : 5,
"offset" : 2,
"payload" : [ {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"tags" : "tags",
"dateUpdated" : 5,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"emailOnFinish" : "emailOnFinish",
"seq" : 1,
"desc" : "desc",
"status" : "status"
}, {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"tags" : "tags",
"dateUpdated" : 5,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"emailOnFinish" : "emailOnFinish",
"seq" : 1,
"desc" : "desc",
"status" : "status"
} ],
"time" : 1589152904320,
"message" : "OK",
"rows" : 7,
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200
403
Access denied
Up
get /api/TransformGroup/{id}.photos
(findTransformphotos)
Searchs Transforms
Path parameters
id (required)
Path Parameter — id format: int64
Query parameters
limit (optional)
Query Parameter — Limit results to this number (if no supplied 100)
sortby (optional)
Query Parameter — Name of concrete column to sort results by
sortbyorder (optional)
Query Parameter — Sort direction (down by default)
Return type
Example data
Content-Type: application/json
{
"total" : 0,
"offset" : 6,
"payload" : [ {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"tags" : "tags",
"dateUpdated" : 5,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"emailOnFinish" : "emailOnFinish",
"seq" : 1,
"desc" : "desc",
"status" : "status"
}, {
"llat" : "llat",
"ulng" : "ulng",
"active" : "active",
"lheight" : "lheight",
"llng" : "llng",
"uheight" : "uheight",
"tags" : "tags",
"dateUpdated" : 5,
"dateMade" : 0,
"name" : "name",
"json" : { },
"id" : 6,
"ulat" : "ulat",
"emailOnFinish" : "emailOnFinish",
"seq" : 1,
"desc" : "desc",
"status" : "status"
} ],
"time" : 1589152904321,
"message" : "OK",
"rows" : 1,
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_11
403
Access denied
Up
delete /api/TransformGroup/{id}.children/{relId}
(getTransformGroupChildrenDel)
Remove association to record TransformGroup's children
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Responses
200
Association added
403
Access denied
Up
post /api/TransformGroup/{id}.children/{relId}
(getTransformGroupChildrenPut)
Adds new association to record TransformGroup's children
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
Association added
403
Access denied
Up
delete /api/TransformGroup/{id}.photos/{relId}
(getTransformGroupPhotosDel)
Remove association to record TransformGroup's photos
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Responses
200
Association added
403
Access denied
Up
post /api/TransformGroup/{id}.photos/{relId}
(getTransformGroupPhotosPut)
Adds new association to record TransformGroup's photos
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
Association added
403
Access denied
Up
delete /api/TransformGroup/{id}.tags/{relId}
(getTransformGroupTagsDel)
Remove association to record TransformGroup's tags
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Responses
200
Association added
403
Access denied
Up
post /api/TransformGroup/{id}.tags/{relId}
(getTransformGroupTagsPut)
Adds new association to record TransformGroup's tags
Path parameters
id (required)
Path Parameter — id format: int64
relId (required)
Path Parameter — id of relationship object to be added format: int64
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
200
Association added
403
Access denied
Up
post /api/TransformGroup
(makeTransformGroup)
Creates a new TransformGroup
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"payload" : {
"active" : "active",
"photos" : "photos",
"tags" : "tags",
"dateUpdated" : 1,
"dateMade" : 0,
"children" : "children",
"name" : "name",
"json" : { },
"id" : 6,
"desc" : "desc",
"status" : "status"
},
"time" : 1589152904320,
"message" : "OK",
"version" : "1.0",
"status" : 200
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Response
inline_response_200_2
403
Access denied
[ Jump to
Methods ]
Table of Contents
AccountAnnotationDatasetFolderJobProjectTransformTransformGroupinline_response_200inline_response_200_1inline_response_200_10inline_response_200_11inline_response_200_12inline_response_200_13inline_response_200_14inline_response_200_15inline_response_200_16inline_response_200_17inline_response_200_18inline_response_200_19inline_response_200_2inline_response_200_20inline_response_200_21inline_response_200_22inline_response_200_23inline_response_200_24inline_response_200_3inline_response_200_4inline_response_200_5inline_response_200_6inline_response_200_7inline_response_200_8inline_response_200_9
parent (optional)
desc (optional)
name (optional)
accountGroups (optional)
isDomain (optional)
json (optional)
closed (optional)
dateMade (optional)
id (optional)
invitedUsers (optional)
uid (optional)
uploadClients (optional)
dateUpdated (optional)
trialEndDate (optional)
plan (optional)
accessSchema (optional)
active (optional)
llng (optional)
desc (optional)
name (optional)
json (optional)
project (optional)
tags (optional)
lheight (optional)
llat (optional)
dateMade (optional)
ulat (optional)
id (optional)
uheight (optional)
uid (optional)
ulng (optional)
seq (optional)
account (optional)
dateUpdated (optional)
transform (optional)
active (optional)
llng (optional)
desc (optional)
name (optional)
json (optional)
lheight (optional)
llat (optional)
dateMade (optional)
ulat (optional)
id (optional)
folder (optional)
uheight (optional)
status (optional)
ulng (optional)
seq (optional)
account (optional)
dataType (optional)
dateUpdated (optional)
initParams (optional)
transform (optional)
active (optional)
crs (optional)
parent (optional)
desc (optional)
name (optional)
json (optional)
forScene (optional)
icon (optional)
plotable (optional)
dateMade (optional)
forJobBatch (optional)
id (optional)
forProject (optional)
account (optional)
dateUpdated (optional)
active (optional)
emailOnFinish (optional)
desc (optional)
name (optional)
json (optional)
project (optional)
jobType (optional)
dateMade (optional)
inputFolders (optional)
id (optional)
folder (optional)
scene (optional)
status (optional)
account (optional)
inputDatasets (optional)
dateUpdated (optional)
current (optional)
active (optional)
llng (optional)
desc (optional)
name (optional)
json (optional)
tags (optional)
lheight (optional)
shareUsers (optional)
llat (optional)
dateMade (optional)
datasets (optional)
ulat (optional)
id (optional)
folders (optional)
uheight (optional)
uid (optional)
ulng (optional)
seq (optional)
account (optional)
dateUpdated (optional)
shareClients (optional)
active (optional)
llng (optional)
emailOnFinish (optional)
desc (optional)
name (optional)
json (optional)
tags (optional)
lheight (optional)
llat (optional)
dateMade (optional)
ulat (optional)
id (optional)
processor (optional)
uheight (optional)
status (optional)
ulng (optional)
seq (optional)
account (optional)
dateUpdated (optional)
transformType (optional)
input (optional)
active (optional)
parent (optional)
children (optional)
desc (optional)
name (optional)
json (optional)
project (optional)
tags (optional)
dateMade (optional)
id (optional)
folder (optional)
status (optional)
account (optional)
dateUpdated (optional)
photos (optional)
active (optional)
jobBatch (optional)
payload (optional)
total (optional)
Long total rows returned in query format: int64
version (optional)
example: 1.0
offset (optional)
Long offset from start of query result set format: int64
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904320
rows (optional)
Long total rows returned in is response format: int64
payload (optional)
total (optional)
Long total rows returned in query format: int64
version (optional)
example: 1.0
offset (optional)
Long offset from start of query result set format: int64
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904320
rows (optional)
Long total rows returned in is response format: int64
payload (optional)
total (optional)
Long total rows returned in query format: int64
version (optional)
example: 1.0
offset (optional)
Long offset from start of query result set format: int64
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904314
rows (optional)
Long total rows returned in is response format: int64
payload (optional)
total (optional)
Long total rows returned in query format: int64
version (optional)
example: 1.0
offset (optional)
Long offset from start of query result set format: int64
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904321
rows (optional)
Long total rows returned in is response format: int64
version (optional)
example: 1.0
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904307
payload (optional)
version (optional)
example: 1.0
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904307
payload (optional)
total (optional)
Long total rows returned in query format: int64
version (optional)
example: 1.0
offset (optional)
Long offset from start of query result set format: int64
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904314
rows (optional)
Long total rows returned in is response format: int64
payload (optional)
total (optional)
Long total rows returned in query format: int64
version (optional)
example: 1.0
offset (optional)
Long offset from start of query result set format: int64
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904311
rows (optional)
Long total rows returned in is response format: int64
payload (optional)
version (optional)
example: 1.0
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904311
payload (optional)
total (optional)
Long total rows returned in query format: int64
version (optional)
example: 1.0
offset (optional)
Long offset from start of query result set format: int64
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904315
rows (optional)
Long total rows returned in is response format: int64
payload (optional)
total (optional)
Long total rows returned in query format: int64
version (optional)
example: 1.0
offset (optional)
Long offset from start of query result set format: int64
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904307
rows (optional)
Long total rows returned in is response format: int64
payload (optional)
total (optional)
Long total rows returned in query format: int64
version (optional)
example: 1.0
offset (optional)
Long offset from start of query result set format: int64
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904311
rows (optional)
Long total rows returned in is response format: int64
payload (optional)
version (optional)
example: 1.0
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904320
payload (optional)
total (optional)
Long total rows returned in query format: int64
version (optional)
example: 1.0
offset (optional)
Long offset from start of query result set format: int64
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904308
rows (optional)
Long total rows returned in is response format: int64
payload (optional)
version (optional)
example: 1.0
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904308
payload (optional)
version (optional)
example: 1.0
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904305
payload (optional)
version (optional)
example: 1.0
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904309
payload (optional)
total (optional)
Long total rows returned in query format: int64
version (optional)
example: 1.0
offset (optional)
Long offset from start of query result set format: int64
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904311
rows (optional)
Long total rows returned in is response format: int64
payload (optional)
total (optional)
Long total rows returned in query format: int64
version (optional)
example: 1.0
offset (optional)
Long offset from start of query result set format: int64
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904313
rows (optional)
Long total rows returned in is response format: int64
payload (optional)
version (optional)
example: 1.0
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904313
payload (optional)
total (optional)
Long total rows returned in query format: int64
version (optional)
example: 1.0
offset (optional)
Long offset from start of query result set format: int64
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904307
rows (optional)
Long total rows returned in is response format: int64
payload (optional)
version (optional)
example: 1.0
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904307
payload (optional)
total (optional)
Long total rows returned in query format: int64
version (optional)
example: 1.0
offset (optional)
Long offset from start of query result set format: int64
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904306
rows (optional)
Long total rows returned in is response format: int64
payload (optional)
total (optional)
Long total rows returned in query format: int64
version (optional)
example: 1.0
offset (optional)
Long offset from start of query result set format: int64
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904322
rows (optional)
Long total rows returned in is response format: int64
payload (optional)
version (optional)
example: 1.0
status (optional)
example: 200
message (optional)
example: OK
time (optional)
example: 1589152904322