Jump to

• Request
• Response

Get endpoints.

get

/connectedWorker/clientapi/v2/orgs/{orgId}/endpointConfigurations/endpoints

This operation retrieves endpoints defined in the organization.

Request

Path Parameters

• orgId: string
  Organization identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Endpoints were successfully retrieved.

Body ()

Root Schema : Endpoints

Type: object

Show Source

• items: array items
• links(optional): array links
  Read Only: true

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Endpoint"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Discriminator: type
  Discriminator: { "propertyName":"type" }

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Endpoint"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Discriminator: type

Type: object

{
    "required":[
        "name",
        "organizationId"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "type":{
            "type":"string",
            "description":"Type of the endpoint",
            "example":"ACCESS_POINT",
            "enum":[
                "ACCESS_POINT"
            ]
        },
        "name":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Human readable name of the endpoint",
            "example":"Endpoint located at first floor"
        },
        "description":{
            "type":"string",
            "description":"More detailed information about the endpoint",
            "example":"Manufacturer: cisco; type: AP-123"
        },
        "organizationId":{
            "type":"string",
            "description":"id of the organization",
            "example":"ORA_DEFAULT_ORG"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "discriminator":{
        "propertyName":"type"
    }
}

Show Source

• description(optional): string
  More detailed information about the endpoint

  Example: Manufacturer: cisco; type: AP-123
• id(optional): string
  Read Only: true

  The unique id of the object

  Example: 53
• links(optional): array links
• name: string
  Minimum Length: 0

  Maximum Length: 255

  Human readable name of the endpoint

  Example: Endpoint located at first floor
• organizationId: string
  id of the organization

  Example: ORA_DEFAULT_ORG
• type(optional): string
  Allowed Values: [ "ACCESS_POINT" ]

  Type of the endpoint

  Example: ACCESS_POINT

{
    "required":[
        "name",
        "organizationId"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "type":{
            "type":"string",
            "description":"Type of the endpoint",
            "example":"ACCESS_POINT",
            "enum":[
                "ACCESS_POINT"
            ]
        },
        "name":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Human readable name of the endpoint",
            "example":"Endpoint located at first floor"
        },
        "description":{
            "type":"string",
            "description":"More detailed information about the endpoint",
            "example":"Manufacturer: cisco; type: AP-123"
        },
        "organizationId":{
            "type":"string",
            "description":"id of the organization",
            "example":"ORA_DEFAULT_ORG"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "discriminator":{
        "propertyName":"type"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top