Nexus
Nexus APIs
GET
/v1/organizations/{organizationId}/aliases/{systemName}/{systemId}
Gets a single organization alias
Parameters
| Name | In | Required | Description |
|---|---|---|---|
organizationId |
path | Yes | |
systemName |
path | Yes | |
systemId |
path | Yes | The system id. |
select |
query | No | One or more comma separated fields to select. |
expand |
query | No | Indicates if the response should expand nested objects. |
Responses
200
Example
{
"created": "string",
"systemId": "string",
"systemName": "string",
"organizationId": 0
}
Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date the alias was created. | — |
organizationId
|
integer (int32)
|
nullable | The id of the organization. | — |
systemId
|
string
|
nullable | Id of the organization in the external system. | — |
systemName
|
string
|
nullable | The name external system. | — |
Example
{
"created": "string",
"systemId": "string",
"systemName": "string",
"organizationId": 0
}
Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date the alias was created. | — |
organizationId
|
integer (int32)
|
nullable | The id of the organization. | — |
systemId
|
string
|
nullable | Id of the organization in the external system. | — |
systemName
|
string
|
nullable | The name external system. | — |
Example
{
"created": "string",
"systemId": "string",
"systemName": "string",
"organizationId": 0
}
Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date the alias was created. | — |
organizationId
|
integer (int32)
|
nullable | The id of the organization. | — |
systemId
|
string
|
nullable | Id of the organization in the external system. | — |
systemName
|
string
|
nullable | The name external system. | — |
Security
Authentication is required for this operation.
Source: default
Requirements (any one option may satisfy)
- Bearer and ApplicationToken
- Basic