Media Attachments

This section describes the details of Media attachment endpoints.

Get Media Object Queues

Retrieve media objects queues names

Endpoint: http(s)://[hostname]:[port]/[context]/service/[version]/media/mediaqueues/[environment]

Method: GET

Content-Type: application/json or application/xml

Accept: application/json or application/xml

Path Parameters

Parameter	Description
hostname	Cantara worker hostname
port	Cantara worker listening port (only required if non-standard HTTP/s port
context	Cantara worker web application context
version	Cantara worker API version
environment	Cantara access environment. Refer to the Managing Environments topic for more information.(Example - E1DEV)

Example Endpoint : https://us.cantara.cloud/cantara/service/50/media/mediaqueues/E1DEV

Example Response

JS

{
    "Message": {
        "value": "Transaction Successful",
        "origin": "Worker7@5bbdad89215b",
        "type": 0,
        "cantaraSid": "5b0430c0-47fb-4a97-9827-e01a76e5990c"
    },
    "name": "GetMediaObjectFileQueues",
    "Query": {
        "QueryRow": [
            {
                "Parameter": [
                    {
                        "value": "BusinessFunctionDoc",
                        "name": "queueName"
                    },
                    {
                        "value": "\\\\nas02.rinami.aus\\Media92\\BusinessFunctionDoc",
                        "name": "moQueuePath"
                    },
                    {
                        "value": "01",
                        "name": "queueType"
                    },
                    {
                        "name": "queueStatus"
                    },
                    {
                        "name": "queuePathOffLine"
                    },
                    {
                        "name": "offLineQueueStatus"
                    }
                ]
            }
        ],
        "handle": "lrj5dc0b84e0384-00001be0-00000839-00000000000000000000ffff0a230134",
        "size": 15,
        "startIndex": 1,
        "endIndex": 1,
        "xmlList": true
    }
}

Get Media Object File

Retrieve media objects queues names

Endpoint: http(s)://[hostname]:[port]/[context]/service/[version]/media/queuefile/[environment]/[queue]/[filename]

Method: GET

Content-Type: application/json or application/xml

Accept: application/json or application/xml

Path Parameters

Parameter	Description
hostname	Cantara worker hostname
port	Cantara worker listening port (only required if non-standard HTTP/s port
context	Cantara worker web application context
version	Cantara worker API version
environment	Cantara access environment. Refer to the Managing Environments topic for more information.(Example - E1DEV)
queue	Media queue name (Eg : RINAMI)
filename	Name of the file (Eg:test.png)

Example Endpoint :https://us.cantara.cloud/cantara/service/50/media/queuefile/E1DEV/RINAMI/test.png

Note

Don't support with AIS

Download Media Objects

Download media objects for the specified queue and key through AIS

Endpoint: http(s)://[hostname]:[port]/[context]/service/[version]/media/queuefile/[environment]

Method: POST

Content-Type: application/json or application/xml

Accept: application/json or application/xml

Path Parameters

Parameter	Description
hostname	Cantara worker hostname
port	Cantara worker listening port (only required if non-standard HTTP/s port
context	Cantara worker web application context
version	Cantara worker API version
environment	Cantara access environment. Refer to the Managing Environments topic for more information.(Example - E1DEV)

Example Endpoint :https://us.cantara.cloud/cantara/service/50/media/queuefile/E1DEV

Example Request

JS

{
    "name": "GetMediaObject",
    "cantaraVersion": "5.1",
    "tenantId": "",
    "apiKey": "",
    "parameter": [
        {
            "value": "RINAMI",
            "name": "queueName"
        },
        {
            "value": "GT4101",
            "name": "objectName"
        },
        {
            "value": "60011",
            "name": "key"
        },
        {
            "value": "1",
            "name": "sequenceNo"
        },
        {
        	"value": "CoolantEngine.jpg",
        	"name": "fileName"
        }
    ]
}

Get Media Objects

Retrieve media objects for the specified queue and key through AIS

Endpoint: http(s)://[hostname]:[port]/[context]/service/[version]/media/objects/[environment]

Method: POST

Content-Type: application/json or application/xml

Accept: application/json or application/xml

Path Parameters

Parameter	Description
hostname	Cantara worker hostname
port	Cantara worker listening port (only required if non-standard HTTP/s port
context	Cantara worker web application context
version	Cantara worker API version
environment	Cantara access environment. Refer to the Managing Environments topic for more information.(Example - E1DEV_AIS)

Example Endpoint :https://us.cantara.cloud/cantara/service/50/media/objects/E1DEV_AIS

Example Request

JS

{
    "name": "GetMedia",
    "cantaraVersion": "5.1",
    "tenantId": "",
    "apiKey": "",
    "parameter": [
        {
            "value": "GT4101",
            "name": "objectName"
        },
        {
            "value": "60011",
            "name": "key"
        }
    ]
}

Example Response

JS

{
    "Message": {
        "value": "Transaction Successful",
        "origin": "Worker24@af746ad838d3",
        "type": 0,
        "cantaraSid": "4e7e194e-bb86-43e2-a738-4804cda4e8c0"
    },
    "name": "GetMediaAISObjects",
    "Query": {
        "QueryRow": [
            {
                "Parameter": [
                    {
                        "value": "GT4101",
                        "name": "nameObject"
                    },
                    {
                        "value": "60011",
                        "name": "key"
                    },
                    {
                        "value": "2",
                        "name": "sequenceNo"
                    },
                    {
                        "value": "0",
                        "name": "objectType"
                    },
                    {
                        "value": "Text2",
                        "name": "itemName"
                    },
                    {
                        "value": "",
                        "name": "queueName"
                    },
                    {
                        "value": "",
                        "name": "fileName"
                    },
                    {
                        "value": "",
                        "name": "futureUse1"
                    },
                    {
                        "value": "This is a sample text attachment in 9.2",
                        "name": "data"
                    }
                ]
            }
        "handle": "",
        "size": 27,
        "startIndex": 1,
        "endIndex": 27,
        "xmlList": true
    }
}

Upload Media Objects With Filepath

Upload media objects with filepath

Endpoint: http(s)://[hostname]:[port]/[context]/service/[version]/media/attach/[environment]

Method: POST

Content-Type: application/json or application/xml

Accept: application/json or application/xml

Path Parameters

Parameter	Description
hostname	Cantara worker hostname
port	Cantara worker listening port (only required if non-standard HTTP/s port
context	Cantara worker web application context
version	Cantara worker API version
environment	Cantara access environment. Refer to the Managing Environments topic for more information.(Example - E1DEV)

Example Endpoint :https://us.cantara.cloud/cantara/service/50/media/attach/E1DEV

Example Request

JS

Eg: From Data
queueName : RINAMI
objectName: GT4101
key: 60011
itemName:Test
file:test.txt

Upload Media Objects With File Endpoint

Upload media objects (attachments) with file endpoint

Endpoint: http(s)://[hostname]:[port]/[context]/service/[version]/media/upload/[environment]/[encodedQueueName]

Method: POST

Content-Type: application/json or application/xml

Accept: application/json or application/xml

Path Parameters

Parameter	Description
hostname	Cantara worker hostname
port	Cantara worker listening port (only required if non-standard HTTP/s port
context	Cantara worker web application context
version	Cantara worker API version
environment	Cantara access environment. Refer to the Managing Environments topic for more information.(Example - E1DEV)
encodedQueueName	queue name (eg : RINAMI)

Example Endpoint :https://us.cantara.cloud/cantara/service/50/media/upload/E1DEV/RINAMI

Example Request

JS

Eg  file name: test.txt

Example Response

JS

{
    "value": "No file found",
    "origin": "Worker24@af746ad838d3",
    "type": 20,
    "sessionId": "",
    "cantaraSid": "4e7e194e-bb86-43e2-a738-4804cda4e8c0"
}

Download Link Endpoint

Download link endpoint

Endpoint: http(s)://[hostname]:[port]/[context]/service/[version]/media/link/[environment]

Method: POST

Content-Type: application/json or application/xml

Accept: application/json or application/xml

Path Parameters

Parameter	Description
hostname	Cantara worker hostname
port	Cantara worker listening port (only required if non-standard HTTP/s port
context	Cantara worker web application context
version	Cantara worker API version
environment	Cantara access environment. Refer to the Managing Environments topic for more information.(Example - E1DEV)

Example Endpoint :https://us.cantara.cloud/cantara/service/50/media/link/E1DEV

Example Request

JS

{
    "name": "GetMediaObject",
    "cantaraVersion": "5.1",
    "tenantId": "",
    "apiKey": "",
    "parameter": [
        {
        	"value": "\\\\nas02.rinami.aus\\Media92\\htmlupload\\FILE-5403108710523429539-1507847646752.pdf",
        	"name": "fileName"
        }
    ]
}

On This Page