Operation

get /data/common/businessObjects/dataDictionary
getDataDictionaryForBusinessObject (getDataDictionaryForBusinessObject : /data/common/businessObjects/dataDictionary)
getDataDictionaryForBusinessObject

Query parameters

Name

IsRequired

Description

businessObjectType optional ---

Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    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

    External Docs
    See Also :

    Operation

    get /data/otn/businessObjects/dataDictionary
    getDataDictionaryForBusinessObject (getDataDictionaryForBusinessObject : /data/otn/businessObjects/dataDictionary)
    getDataDictionaryForBusinessObject

    Query parameters

    Name

    IsRequired

    Description

    businessObjectType optional ---

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    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

    External Docs
    See Also :

    Operation

    get /data/common/businessObjects/list
    getListOfBusinessObjects (getListOfBusinessObjects : /data/common/businessObjects/list)
    getListOfBusinessObjects


    Return type
  • array[String]
  • Responses

    Response Messages

    Schema

    200success array[String]
    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

    External Docs
    See Also :

    Operation

    get /data/otn/businessObjects/list
    getListOfBusinessObjects (getListOfBusinessObjects : /data/otn/businessObjects/list)
    getListOfBusinessObjects


    Return type
  • array[String]
  • Responses

    Response Messages

    Schema

    200success array[String]
    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

    External Docs
    See Also :

    Operation

    get /data/common/businessObjects/filterNames
    getListOfFilterNames (getListOfFilterNames : /data/common/businessObjects/filterNames)
    getListOfFilterNames

    Query parameters

    Name

    IsRequired

    Description

    businessObjectType optional ---
    filterName optional ---

    Return type
  • array[String]
  • Responses

    Response Messages

    Schema

    200success array[String]
    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

    External Docs
    See Also :

    Operation

    get /data/common/businessObjects/namedFilters
    getListOfFilterNames (getListOfFilterNames : /data/common/businessObjects/namedFilters)
    getListOfFilterNames

    Query parameters

    Name

    IsRequired

    Description

    businessObjectType optional ---
    filterName optional ---

    Return type
  • array[String]
  • Responses

    Response Messages

    Schema

    200success array[String]
    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

    External Docs
    See Also :

    Operation

    get /data/common/businessObjects/namedFilters/names
    getListOfFilterNames (getListOfFilterNames : /data/common/businessObjects/namedFilters/names)
    getListOfFilterNames

    Query parameters

    Name

    IsRequired

    Description

    businessObjectType optional ---
    filterName optional ---

    Return type
  • array[String]
  • Responses

    Response Messages

    Schema

    200success array[String]
    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

    External Docs
    See Also :

    Operation

    get /data/otn/businessObjects/filterNames
    getListOfFilterNames (getListOfFilterNames : /data/otn/businessObjects/filterNames)
    getListOfFilterNames

    Query parameters

    Name

    IsRequired

    Description

    businessObjectType optional ---
    filterName optional ---

    Return type
  • array[String]
  • Responses

    Response Messages

    Schema

    200success array[String]
    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

    External Docs
    See Also :

    Operation

    get /data/otn/businessObjects/namedFilters
    getListOfFilterNames (getListOfFilterNames : /data/otn/businessObjects/namedFilters)
    getListOfFilterNames

    Query parameters

    Name

    IsRequired

    Description

    businessObjectType optional ---
    filterName optional ---

    Return type
  • array[String]
  • Responses

    Response Messages

    Schema

    200success array[String]
    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

    External Docs
    See Also :

    Operation

    get /data/otn/businessObjects/namedFilters/names
    getListOfFilterNames (getListOfFilterNames : /data/otn/businessObjects/namedFilters/names)
    getListOfFilterNames

    Query parameters

    Name

    IsRequired

    Description

    businessObjectType optional ---
    filterName optional ---

    Return type
  • array[String]
  • Responses

    Response Messages

    Schema

    200success array[String]
    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

    External Docs
    See Also :

    Operation

    get /data/common/businessObjects
    getObjectDataByNamedFilter (getObjectDataByNamedFilter : /data/common/businessObjects)
    getObjectDataByNamedFilter

    Query parameters

    Name

    IsRequired

    Description

    businessObjectType optional ---
    filterName required ---
    additionalFilter optional ---
    groupBy optional ---
    sortBy optional ---
    groupByDay optional ---

    Return type
  • ConnectionStatsResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionStatsResponse
    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

    External Docs
    See Also :

    Operation

    get /data/otn/businessObjects
    getObjectDataByNamedFilter (getObjectDataByNamedFilter : /data/otn/businessObjects)
    getObjectDataByNamedFilter

    Query parameters

    Name

    IsRequired

    Description

    businessObjectType optional ---
    filterName required ---
    additionalFilter optional ---
    groupBy optional ---
    sortBy optional ---
    groupByDay optional ---

    Return type
  • ConnectionStatsResponse
  • Responses

    Response Messages

    Schema

    200success ConnectionStatsResponse
    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

    External Docs
    See Also :

    BaseDataPointObject

    Name

    Type

    Description

    Enum

    label String string --- ---
    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---
    parentId String string --- ---
    hasChildren String string --- ---
    characteristic Object object --- ---
    group Object object --- ---
    datum Object object --- ---
    value Object object --- ---
    name Object object --- ---

    BaseObject

    Name

    Type

    Description

    Enum

    label String string --- ---
    className String string --- ---
    id String string --- ---
    key String string --- ---
    guiLabel String string --- ---
    parentId String string --- ---
    hasChildren String string --- ---

    ConnectionStatsResponse

    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 --- ---
    dataPoints array[DataPoint] DataPoint --- ---
    dataPointsByObjectId array[Entry«object,List«BaseDataPointObject»»] Entry«object,List«BaseDataPointObject»» --- ---
    invalidInputIds array[Object] object --- ---
    items array[Object] object --- ---
    objectDetails array[Entry«string,BaseObject»] Entry«string,BaseObject» --- ---
    failedCompletion Boolean boolean --- ---
    successfulCompletion Boolean boolean --- ---
    timeout Long long --- ---
    nadString String string --- ---

    DataPoint

    Name

    Type

    Description

    Enum

    characteristic Object object --- ---
    datum Object object --- ---
    group Object object --- ---
    value Object object --- ---

    Entry«object,List«BaseDataPointObject»»

    Name

    Type

    Description

    Enum

    key array[BaseDataPointObject] BaseDataPointObject --- ---

    Entry«string,BaseObject»

    Name

    Type

    Description

    Enum

    key BaseObject BaseObject --- ---

    inline_response_200

    Name

    Type

    Description

    Enum

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