Jump to

• Request
• Response
• Examples

Fetch a program's organization hierarchy

get

/rest/api/v1.3/attributes/programs/{programName}

Fetch a list of organizations that can access a program.

Request

Supported Media Types

• application/json

Path Parameters

• programName: string
  The Program name

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Get Assigned Organizations

Type: object

Title: Get Assigned Organizations

Show Source

• attributes(optional): object attributes

{
    "title":"Get Assigned Organizations",
    "type":"object",
    "properties":{
        "attributes":{
            "type":"object",
            "properties":{
                "organizations":{
                    "type":"object",
                    "properties":{
                        "attributeValues":{
                            "description":"Value of the Assigned Attributes",
                            "type":"array",
                            "items":{
                                "$ref":"#/definitions/assigned-attribute"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : attributes

Type: object

Show Source

• organizations(optional): object organizations

{
    "type":"object",
    "properties":{
        "organizations":{
            "type":"object",
            "properties":{
                "attributeValues":{
                    "description":"Value of the Assigned Attributes",
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/assigned-attribute"
                    }
                }
            }
        }
    }
}

Nested Schema : organizations

Type: object

Show Source

• attributeValues(optional): array attributeValues
  Value of the Assigned Attributes

{
    "type":"object",
    "properties":{
        "attributeValues":{
            "description":"Value of the Assigned Attributes",
            "type":"array",
            "items":{
                "$ref":"#/definitions/assigned-attribute"
            }
        }
    }
}

Nested Schema : attributeValues

Type: array

Value of the Assigned Attributes

Show Source

• Array of: object assigned attribute
  Title: assigned attribute

{
    "description":"Value of the Assigned Attributes",
    "type":"array",
    "items":{
        "$ref":"#/definitions/assigned-attribute"
    }
}

Nested Schema : assigned attribute

Type: object

Title: assigned attribute

Show Source

• id(optional): string
  ID of the attribute
• lineage(optional): string
  Description of the attribute's heirarchy
• name(optional): string
  Name of the attribute

{
    "type":"object",
    "title":"assigned attribute",
    "properties":{
        "id":{
            "description":"ID of the attribute",
            "type":"string"
        },
        "name":{
            "description":"Name of the attribute",
            "type":"string"
        },
        "lineage":{
            "description":"Description of the attribute's heirarchy",
            "type":"string"
        }
    }
}

Back to Top

Examples

This interface is used to retrieve the organizations which have access to a program. To learn more about Organizations in Responsys, see the Responsys Help Center.

A successful request requires the following headers:

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>

Sample Request URL:

/rest/api/v1.3/attributes/programs/example_program

Sample response: Success

{
  "attributes": {
    "organizations": {
      "attributeValues": [
        {
          "id": 7,
          "name": "USA",
          "lineage": "7:"
        }
      ]
    }
  }
}
	

Sample Response: Failure

If the program does not exist, the error will resemble the following:

{
  "type": "",
  "title": "Program not found",
  "errorCode": "PROGRAM_NOT_FOUND",
  "detail": "Program with the name example_progrm not found",
  "errorDetails": []
}
     

Back to Top