Jump to

• Request
• Response
• Examples

Get all resources having named IDs

get

/services/rest/connect/v1.4/namedIDs/

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Collection of resources having namedIDHierarchies

Type: object

Title: Collection of resources having namedIDHierarchies

Collection of resources having namedIDHierarchies

Show Source

• items(optional): array items

{
    "properties":{
        "items":{
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "description":"resources having namedIDHierarchies"
                    }
                }
            },
            "type":"array"
        }
    },
    "type":"object",
    "description":"Collection of resources having namedIDHierarchies",
    "title":"Collection of resources having namedIDHierarchies"
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "description":"resources having namedIDHierarchies"
            }
        }
    },
    "type":"array"
}

Nested Schema : items

Type: object

Show Source

• name(optional): string
  resources having namedIDHierarchies

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"resources having namedIDHierarchies"
        }
    }
}

Back to Top

Examples

Use GET with the following syntax to list the resources that have named IDs:

https://your_site_interface/services/rest/connect/version/namedIDs

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/namedIDs

Response body example

{
  "items": [
    {
      "name": "accounts",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/accounts"
        }
      ]
    },
    {
      "name": "analyticsReports",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/analyticsReports"
        }
      ]
    },
    {
      "name": "answers",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/answers"
        }
      ]
    },
    {
      "name": "assets",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/assets"
        }
      ]
    },
    {
      "name": "assetStatuses",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/assetStatuses"
        }
      ]
    },
    {
      "name": "channelTypes",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/channelTypes"
        }
      ]
    },
    {
      "name": "configurations",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/configurations"
        }
      ]
    },
    {
      "name": "contacts",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/contacts"
        }
      ]
    },
    {
      "name": "countries",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/countries"
        }
      ]
    },
    {
      "name": "eventSubscriptions",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/eventSubscriptions"
        }
      ]
    },
    {
      "name": "holidays",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/holidays"
        }
      ]
    },
    {
      "name": "incidents",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/incidents"
        }
      ]
    },
    {
      "name": "mailboxes",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/mailboxes"
        }
      ]
    },
    {
      "name": "marketingMailboxes",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/marketingMailboxes"
        }
      ]
    },
    {
      "name": "messageBases",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/messageBases"
        }
      ]
    },
    {
      "name": "opportunities",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/opportunities"
        }
      ]
    },
    {
      "name": "organizations",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/organizations"
        }
      ]
    },
    {
      "name": "purchasedProducts",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/purchasedProducts"
        }
      ]
    },
    {
      "name": "salesProducts",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/salesProducts"
        }
      ]
    },
    {
      "name": "salesTerritories",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/salesTerritories"
        }
      ]
    },
    {
      "name": "serviceCategories",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/serviceCategories"
        }
      ]
    },
    {
      "name": "serviceDispositions",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/serviceDispositions"
        }
      ]
    },
    {
      "name": "serviceMailboxes",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/serviceMailboxes"
        }
      ]
    },
    {
      "name": "serviceProducts",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/serviceProducts"
        }
      ]
    },
    {
      "name": "siteInterfaces",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/siteInterfaces"
        }
      ]
    },
    {
      "name": "standardContents",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/standardContents"
        }
      ]
    },
    {
      "name": "tasks",
      "links": [
        {
          "rel": "canonical",
          "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs/tasks"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/namedIDs"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/namedIDs",
      "mediaType": "application/schema+json"
    }
  ]
}

Back to Top