url

url is used to specify a valid URL where the given object can be found, instead of passing a blob. This is valid for Add* commands that currently expect a blob, except for AddDescriptor.

We currently support S3 buckets for remote location specified as S3 URI. The expected format for S3 is "s3://bucket-name/path-to-object/object-name".

Examples

Insert an image that already lives in an S3 bucket. No blob must be passed for this command with the JSON Query.

[{
    "AddImage": {
        "properties": {
            "type": "scan",
            "part": "brain"
        },
        "url": "s3://aperturedata-public/pngs/trial.png"
    }
}]

Response:

[{
    "AddImage": {
        "status": 0
    }
}]