...
| Code Block |
|---|
GET <base>/v1/packages.json <base>/v1/packages/<package-name>/<version>/icon.jpgpng <base>/v1/packages/<package-name>/<version>/license.txt <base>/v1/packages/<package-name>/<version>/spec.json <base>/v1/packages/<package-name>/<version>/spec.json.asc <base>/v1/packages/<package-name>/<version>/archive.zip <base>/v1/packages/<package-name>/<version>/archive.zip.asc |
...
| Code Block |
|---|
GET /v1/packages/<package-name>/<version>/icon.jpgpng ex: GET /v1/packages/PurchaseExample/4.0.0/icon.jpgpng [ icon bytes ] |
Get Package License
...
| Code Block |
|---|
{
"type": "create_artifact" | "create_app" | "create_stream" | "create_dataset" | "load_datapack" | "install_package"
"arguments": [
{
"name": [argument name],
"value": [argument value],
"canModify": true | false (defaults to false)
}
]
} |
...
| name | description | required? | default |
|---|---|---|---|
| name | artifact name | yes | |
| jar | name of jar file in package archive | no (if using externalArchive) | |
| externalJar | link to download 3rd party jar | no | none |
| externalArchive | link to download 3rd party archive | no | none |
| externalArchiveSignature | link to get 3rd party archive signature | no | none |
| externalArchiveJar | path of the jar file in the external archive | no | none |
| scope | artifact scope (implies API to add system artifacts is added in 4.0) | no | user |
| version | artifact version to pass as Artifact-Version header | no | none |
| config | config file contains artifact parents, plugins, and properties | no | none |
...
| name | description | required? | default | ||||
|---|---|---|---|---|---|---|---|
| name | stream name | yes | |||||
| description | stream description, results in call to set stream properties | no | empty | ||||
| format | stream format as json object, results in call to set stream properties | no | empty | ||||
| schema | stream schema, results in call to set stream properties | no | empty | ||||
| ttl | stream ttl, results in call to set stream properties | no | empty | ||||
| notification.threshold.mb | mb threshold for sending notifications, results in call to set stream properties | no | empty | loadfiles | files in the package archive to write to the stream. results in a call to write to the stream in batch | no | empty |
create_dataset
Results in a call to http://docs.cdap.io/cdap/current/en/reference-manual/http-restful-api/dataset.html#creating-a-dataset
| name | description | required? | default |
|---|---|---|---|
| name | dataset name | yes | |
| type | dataset type | yes | |
| description | dataset description | no | empty |
| properties | json map of dataset properties | no | empty |
load_datapack
Loads a datapack into some dataset or stream.
| name | description | required? | default |
|---|---|---|---|
| name | dataset/stream name | yes | |
| files | files to load into the dataset/stream | yes |
install_package
Installs another package from the marketplace. May not be implemented for version 1.
| name | description | required? | default |
|---|---|---|---|
| name | package name | yes | |
| version | package version | yes |
...