Operation
get /data/otn/olcStateQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | optional | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
BaseInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json;charset=UTF-8
External Docs
Operation
get /data/otn/olcState/ancestorsQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
BaseInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json;charset=UTF-8
External Docs
Operation
get /data/otn/olcState/ascendantsQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
BaseInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json;charset=UTF-8
External Docs
Operation
get /data/otn/olcState/selfAndAncestorsQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
BaseInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json;charset=UTF-8
External Docs
Operation
get /data/otn/olcState/selfAndAscendantsQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
BaseInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json;charset=UTF-8
External Docs
Operation
get /data/otn/olcState/selfAndDescendantsQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
BaseInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json;charset=UTF-8
External Docs
Operation
get /data/otn/olcState/selfAndDescendentsQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
BaseInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json;charset=UTF-8
External Docs
Operation
get /data/otn/olcState/descendantsQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
BaseInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json;charset=UTF-8
External Docs
Operation
get /data/otn/olcState/descendentsQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
BaseInventoryResponse
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json;charset=UTF-8
External Docs
Operation
get /data/otn/olcState/maintenance/ancestorQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
Boolean
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json;charset=UTF-8
External Docs
Operation
get /data/otn/olcState/maintenance/selfOrAncestorQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
Boolean
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json;charset=UTF-8
External Docs
Operation
get /data/otn/olcState/sysParamEnabledReturn type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
Boolean
|
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Produces
application/json;charset=UTF-8
External Docs
Operation
put /data/otn/olcState/{id}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | id | --- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| newValue | required | --- |
| objectType | required | --- |
| userLabel | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
Operation
post /data/otn/olcState/{id}Path parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | id | --- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| newValue | required | --- |
| objectType | required | --- |
| userLabel | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
Operation
put /data/otn/connection/{id}/olcStatePath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | id | --- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| newValue | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
Operation
post /data/otn/connection/{id}/olcStatePath parameters
Name |
IsRequired |
Description |
Enum |
|---|---|---|---|
| id | required | id | --- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| newValue | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
Operation
put /data/otn/olcStateRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | OlcStateRequestList |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
Operation
post /data/otn/olcStateRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | OlcStateRequestList |
--- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
Operation
put /data/otn/olcState/hierarchyRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | OlcStateRequestList |
--- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
Operation
post /data/otn/olcState/hierarchyRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | OlcStateRequestList |
--- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
Operation
put /data/otn/olcState/selfAndDescendentsRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | OlcStateRequestList |
--- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
Operation
post /data/otn/olcState/selfAndDescendentsRequest body
Name |
IsRequired |
Description |
Data Type |
Enum |
|---|---|---|---|---|
| body | optional | req | OlcStateRequestList |
--- |
Query parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| objectType | optional | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
Operation
put /data/otn/olcState/fdnQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| newFdn | required | --- |
| objectType | required | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
Operation
post /data/otn/olcState/fdnQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| newFdn | required | --- |
| objectType | required | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
Operation
put /data/otn/olcState/fdnAndUserLabelQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| newFdn | required | --- |
| newUserLabel | required | --- |
| objectType | required | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
Operation
post /data/otn/olcState/fdnAndUserLabelQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| newFdn | required | --- |
| newUserLabel | required | --- |
| objectType | required | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
Operation
put /data/otn/olcState/userLabelQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| newUserLabel | required | --- |
| objectType | required | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
Operation
post /data/otn/olcState/userLabelQuery parameters
Name |
IsRequired |
Description |
|---|---|---|
| fdn | required | --- |
| newUserLabel | required | --- |
| objectType | required | --- |
Return type
Responses
Response Messages |
Schema |
|---|---|
| 200success |
OLCStateUpdateResponse
|
| 201Created | --- |
| 401Unauthorized | --- |
| 403Forbidden | --- |
| 404Not Found | --- |
Consumes
application/json
Produces
application/json;charset=UTF-8
External Docs
BaseInventoryResponse
Name |
Type |
Description |
Enum |
|---|---|---|---|
| reqCompletionStatus | Integer integer |
--- | --- |
| requestId | Long long |
--- | --- |
| clientName | String string |
--- | --- |
| clientLocation | String string |
--- | --- |
| clientUser | String string |
--- | --- |
| sessionId | String string |
--- | --- |
| mdcId | String string |
--- | --- |
| sequenceNum | Integer integer |
--- | --- |
| moreToCome | Boolean boolean |
--- | --- |
| messages | array[OtnI18nMessage] OtnI18nMessage |
--- | --- |
| errcde | String string |
--- | --- |
| errorParams | array[Object] object |
--- | --- |
| nextTasks | array[String] string |
--- | --- |
| items | array[Object] object |
--- | --- |
| data | array[Object] object |
--- | --- |
| failedCompletion | Boolean boolean |
--- | --- |
| successfulCompletion | Boolean boolean |
--- | --- |
| timeout | Long long |
--- | --- |
| nadString | String string |
--- | --- |
OlcStateRequestList
Name |
Type |
Description |
Enum |
|---|---|---|---|
| items | array[OlcStateRequestObject] OlcStateRequestObject |
--- | --- |
OLCStateUpdateResponse
Name |
Type |
Description |
Enum |
|---|---|---|---|
| responseStatus | Integer integer |
--- | --- |
| response | String string |
--- | --- |
| message | String string |
--- | --- |
| messageId | String string |
--- | --- |
| messageSeverity | String string |
--- | --- |
| errorField | String string |
--- | --- |
| errorValue | String string |
--- | --- |
| operationLogMsg | OtnI18nMessage OtnI18nMessage |
--- | --- |
| status | String string |
--- | --- |
| reqCompletionStatus | Integer integer |
--- | --- |
OtnI18nMessage
Name |
Type |
Description |
Enum |
|---|---|---|---|
| messageType | String string |
--- | [Info, Warning, Error] |
| messageUnformatted | String string |
--- | --- |
| validPropertyResourceMessage | Boolean boolean |
--- | --- |
| messageId | String string |
--- | --- |
| messageParams | array[String] string |
--- | --- |
| messageTime | Long long |
--- | --- |
| message | String string |
--- | --- |