Operation

get /data/otn/olcState
getOLCState (getOLCState : /data/otn/olcState)
getOLCState

Query parameters

Name

IsRequired

Description

fdn optional ---
objectType optional ---

Return type
  • BaseInventoryResponse
  • Responses

    Response Messages

    Schema

    200success BaseInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    get /data/otn/olcState/ancestors
    getOlcStateObjectAncestors (getOlcStateObjectAncestors : /data/otn/olcState/ancestors)
    getOlcStateObjectAncestors

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • BaseInventoryResponse
  • Responses

    Response Messages

    Schema

    200success BaseInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    get /data/otn/olcState/ascendants
    getOlcStateObjectAncestors (getOlcStateObjectAncestors : /data/otn/olcState/ascendants)
    getOlcStateObjectAncestors

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • BaseInventoryResponse
  • Responses

    Response Messages

    Schema

    200success BaseInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    get /data/otn/olcState/selfAndAncestors
    getOlcStateObjectAndAncestors (getOlcStateObjectAndAncestors : /data/otn/olcState/selfAndAncestors)
    getOlcStateObjectAndAncestors

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • BaseInventoryResponse
  • Responses

    Response Messages

    Schema

    200success BaseInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    get /data/otn/olcState/selfAndAscendants
    getOlcStateObjectAndAncestors (getOlcStateObjectAndAncestors : /data/otn/olcState/selfAndAscendants)
    getOlcStateObjectAndAncestors

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • BaseInventoryResponse
  • Responses

    Response Messages

    Schema

    200success BaseInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    get /data/otn/olcState/selfAndDescendants
    getOlcStateObjectAndDescendents (getOlcStateObjectAndDescendents : /data/otn/olcState/selfAndDescendants)
    getOlcStateObjectAndDescendents

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • BaseInventoryResponse
  • Responses

    Response Messages

    Schema

    200success BaseInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    get /data/otn/olcState/selfAndDescendents
    getOlcStateObjectAndDescendents (getOlcStateObjectAndDescendents : /data/otn/olcState/selfAndDescendents)
    getOlcStateObjectAndDescendents

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • BaseInventoryResponse
  • Responses

    Response Messages

    Schema

    200success BaseInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    get /data/otn/olcState/descendants
    getOlcStateObjectDescendents (getOlcStateObjectDescendents : /data/otn/olcState/descendants)
    getOlcStateObjectDescendents

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • BaseInventoryResponse
  • Responses

    Response Messages

    Schema

    200success BaseInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    get /data/otn/olcState/descendents
    getOlcStateObjectDescendents (getOlcStateObjectDescendents : /data/otn/olcState/descendents)
    getOlcStateObjectDescendents

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • BaseInventoryResponse
  • Responses

    Response Messages

    Schema

    200success BaseInventoryResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    get /data/otn/olcState/maintenance/ancestor
    isAncestorInMaintenance (isAncestorInMaintenance : /data/otn/olcState/maintenance/ancestor)
    isAncestorInMaintenance

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Boolean
  • Responses

    Response Messages

    Schema

    200success Boolean
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    get /data/otn/olcState/maintenance/selfOrAncestor
    isObjectInMaintenance (isObjectInMaintenance : /data/otn/olcState/maintenance/selfOrAncestor)
    isObjectInMaintenance

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • Boolean
  • Responses

    Response Messages

    Schema

    200success Boolean
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    get /data/otn/olcState/sysParamEnabled
    isOlcSystemParameterEnabled (isOlcSystemParameterEnabled : /data/otn/olcState/sysParamEnabled)
    isOlcSystemParameterEnabled


    Return type
  • Boolean
  • Responses

    Response Messages

    Schema

    200success Boolean
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    put /data/otn/olcState/{id}
    setOLCState (setOLCState : /data/otn/olcState/{id})
    setOLCState

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newValue required ---
    objectType required ---
    userLabel optional ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    post /data/otn/olcState/{id}
    setOLCState (setOLCState : /data/otn/olcState/{id}_8)
    setOLCState

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newValue required ---
    objectType required ---
    userLabel optional ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    put /data/otn/connection/{id}/olcState
    setOLCStateForConns (setOLCStateForConns : /data/otn/connection/{id}/olcState)
    setOLCStateForConns

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    newValue required ---
    objectType optional ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    post /data/otn/connection/{id}/olcState
    setOLCStateForConns (setOLCStateForConns : /data/otn/connection/{id}/olcState_1)
    setOLCStateForConns

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    newValue required ---
    objectType optional ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    put /data/otn/olcState
    setOLCStateForEntityList (setOLCStateForEntityList : /data/otn/olcState)
    setOLCStateForEntityList

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OlcStateRequestList ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    post /data/otn/olcState
    setOLCStateForEntityList (setOLCStateForEntityList : /data/otn/olcState_2)
    setOLCStateForEntityList

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OlcStateRequestList ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    put /data/otn/olcState/hierarchy
    setOLCStateObjectAndDescendentsInService (setOLCStateObjectAndDescendentsInService : /data/otn/olcState/hierarchy)
    setOLCStateObjectAndDescendentsInService

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OlcStateRequestList ---
    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    post /data/otn/olcState/hierarchy
    setOLCStateObjectAndDescendentsInService (setOLCStateObjectAndDescendentsInService : /data/otn/olcState/hierarchy_5)
    setOLCStateObjectAndDescendentsInService

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OlcStateRequestList ---
    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    put /data/otn/olcState/selfAndDescendents
    setOLCStateObjectAndDescendentsInService (setOLCStateObjectAndDescendentsInService : /data/otn/olcState/selfAndDescendents)
    setOLCStateObjectAndDescendentsInService

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OlcStateRequestList ---
    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    post /data/otn/olcState/selfAndDescendents
    setOLCStateObjectAndDescendentsInService (setOLCStateObjectAndDescendentsInService : /data/otn/olcState/selfAndDescendents_6)
    setOLCStateObjectAndDescendentsInService

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional req OlcStateRequestList ---
    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    objectType optional ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    put /data/otn/olcState/fdn
    updateFdn (updateFdn : /data/otn/olcState/fdn)
    updateFdn

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newFdn required ---
    objectType required ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    post /data/otn/olcState/fdn
    updateFdn (updateFdn : /data/otn/olcState/fdn_3)
    updateFdn

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newFdn required ---
    objectType required ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    put /data/otn/olcState/fdnAndUserLabel
    updateFdnAndUserLabel (updateFdnAndUserLabel : /data/otn/olcState/fdnAndUserLabel)
    updateFdnAndUserLabel

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newFdn required ---
    newUserLabel required ---
    objectType required ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    post /data/otn/olcState/fdnAndUserLabel
    updateFdnAndUserLabel (updateFdnAndUserLabel : /data/otn/olcState/fdnAndUserLabel_4)
    updateFdnAndUserLabel

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newFdn required ---
    newUserLabel required ---
    objectType required ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    put /data/otn/olcState/userLabel
    updateUserLabel (updateUserLabel : /data/otn/olcState/userLabel)
    updateUserLabel

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newUserLabel required ---
    objectType required ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    Operation

    post /data/otn/olcState/userLabel
    updateUserLabel (updateUserLabel : /data/otn/olcState/userLabel_7)
    updateUserLabel

    Query parameters

    Name

    IsRequired

    Description

    fdn required ---
    newUserLabel required ---
    objectType required ---

    Return type
  • OLCStateUpdateResponse
  • Responses

    Response Messages

    Schema

    200success OLCStateUpdateResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8

    External Docs
    See Also :

    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 --- ---

    OlcStateRequestObject

    Name

    Type

    Description

    Enum

    id String string --- ---
    olcState String string --- ---
    objectType String string --- ---
    fdn String string --- ---
    targetPageUrl String string --- ---
    targetDataUrl String string --- ---
    userLabel String string --- ---
    additionalInfo String string --- ---

    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 --- ---