Operation

post /eqm/prov/{groupId}/{neId}/{neType}
createEntity (createEntity : /eqm/prov/{groupId}/{neId}/{neType})
createEntity

Path parameters

Name

IsRequired

Description

Enum

neId required neId ---
groupId required groupId ---
neType required neType ---
Request body

Name

IsRequired

Description

Data Type

Enum

body optional provEntity ProvisionedEntity ---
body2 optional Session HttpSession ---

Return type
  • Status
  • Responses

    Response Messages

    Schema

    200success Status
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    REST call: /eqm/prov/6601/10/1830pss-ocs Provisioned Entity Data: <ProvisionedEntity> <entityType>EQUIPMENT</entityType> <groupId>6601</groupId> <neId>10</neId> <entityName>SHELF-1-7</entityName> <parameterList> <parameter> <name>expectedEquipmentObjectType</name> <value>PSS36</value> </parameter> <parameter> <name>primaryState</name> <value>OUT_OF_SERVICE</value> </parameter> <parameter> <name>appl</name> <value>OCS</value> </parameter> <parameter> <name>airflowappl</name> <value>HP36</value> </parameter> <parameter> <name>asap</name> <value>LBL-ASAPEQPT-ALL</value> </parameter> <parameter> <name>mtxsize</name> <value>960</value> </parameter> </parameterList> </ProvisionedEntity>

    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/xml
    Example Response Data
    <Status> <opStatus>SUCCESS</opStatus> <msg>CREATE SHELF-1-7</msg> </Status>

    External Docs
    See Also :

    Operation

    delete /eqm/prov/{groupId}/{neId}/{neType}/{entityType}/{aid}
    deleteEntity (deleteEntity : /eqm/prov/{groupId}/{neId}/{neType}/{entityType}/{aid})
    deleteEntity

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required groupId ---
    neId required neId ---
    neType required neType ---
    entityType required entityType ---
    aid required aid ---

    Return type
  • Status
  • Responses

    Response Messages

    Schema

    200success Status
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • text/xml
    Example Request Data

    /eqm/prov/6601/11/1830pss-32/EQ/SHELF-6

    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/xml
    Example Response Data
    <Status> <opStatus>SUCCESS</opStatus> <msg>DELETE SHELF-6</msg> </Status>

    External Docs
    See Also :

    Operation

    get /eqm/prov/{groupId}/{neId}
    getEntity (getEntity : /eqm/prov/{groupId}/{neId})
    getEntity


    Return type
  • ProvisionedEntity
  • Responses

    Response Messages

    Schema

    200success ProvisionedEntity
    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/xml

    External Docs
    See Also :

    Operation

    put /eqm/prov/{groupId}/{neId}/{neType}
    modifyEntity (modifyEntity : /eqm/prov/{groupId}/{neId}/{neType})
    modifyEntity

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neId required neId ---
    groupId required groupId ---
    neType required neType ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional provEntity ProvisionedEntity ---
    body2 optional session1 HttpSession ---

    Return type
  • Status
  • Responses

    Response Messages

    Schema

    200success Status
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    Operation

    get /eqm/prov/Set/{groupId}/{neId}/{neType}
    modifyEntityForPort (modifyEntityForPort : /eqm/prov/Set/{groupId}/{neId}/{neType})
    modifyEntityForPort

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neId required neId ---
    groupId required groupId ---
    neType required neType ---

    Return type
  • Status
  • Responses

    Response Messages

    Schema

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

    put /eqm/prov/loopBackDetails/{groupId}/{neId}/{neType}/{signalrate}
    modifyloopBackDetails (modifyloopBackDetails : /eqm/prov/loopBackDetails/{groupId}/{neId}/{neType}/{signalrate})
    modifyloopBackDetails

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neId required neId ---
    groupId required groupId ---
    neType required neType ---
    signalrate required signalrate ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional provEntity ProvisionedEntity ---
    body2 optional session1 HttpSession ---

    Return type
  • Status
  • Responses

    Response Messages

    Schema

    200success Status
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    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/xml

    External Docs
    See Also :

    EntityParameter

    Name

    Type

    Description

    Enum

    name String string --- ---
    value String string --- ---

    HashMap«string,EntityParameter»

    Name

    Type

    Description

    Enum

    ProvisionedEntity

    Name

    Type

    Description

    Enum

    entityType String string --- ---
    groupId String string --- ---
    neId String string --- ---
    entityName String string --- ---
    paramList array[EntityParameter] EntityParameter --- ---

    Status

    Name

    Type

    Description

    Enum

    opStatus String string --- ---
    msg String string --- ---