Get Object Resources

Purpose

This method retrieves a list of applicable objects-id for an interaction object in the system. The result is the list of object-ids (e.g., a list of available Interactions).

URI Syntax and Example

http://[host:port]Application Name/version/[version]/account/[accountID]/[object]

http://api.Interact.jacada.com/version/1/account/12345678/interaction

HTTP Method

GET

Response

HTTP OK 200

tog_minusBody Response Parameters

The Get Object Resources example body parameters are as follows:

Field Name

Data Type

Description

spaceMessage

String

A message to show if no Interactions are published.

spaceTitle

String

Title of section.

spaceInteractions

String

List of Interactions.

id

String

Interaction id.

interactionName

String

Name of Interaction.

pageTitle

String

Title of the Interactions page.

tog_minusBody Response Example

A Get Object Resources body example is as follows:

{

 "resources": {

         "spaces": [

{

"spaceMessage": "There are no Interactions published by 'default_space'"

},

{

    "spaceInteractions": [

    {

        "id": "1346760067895-2236d625c23f0a6aa8c0156499321399127b708-773c",

        "interactionName": "Api tests",

        "description" : "This interaction is for A case"

    },

    {

        "id": "1345120507463-1d625c23f0a6aa8c0242b71101392f6e1647-8000",

        "interactionName": "API tests",

        "description" : "This interaction is for B case"

    }],

    "spaceTitle": "<b>My Interactions</b>"

}],

"pageTitle": "Interactions"

 }

}