Operation
post /pae/paeSet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category}
Create,Modify or DELETE the Protection Audit Entity for OPSOSM packs for VWM NE. (modifyShelforCardLevelPAE : /pae/paeSet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category})
The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.
*For create or Edit slotA value would be formatted as opsosmSlotA_opsosmSlotZ and
*For create this value would be formatted as desc_revertive_paeStatus_waitToRestoreTimer and
for edit this value is formatted as desc_revertive_waitToRestoreTimer_activate
*For create or Edit slotA value would be formatted as opsosmSlotA_opsosmSlotZ and
*For create this value would be formatted as desc_revertive_paeStatus_waitToRestoreTimer and
for edit this value is formatted as desc_revertive_waitToRestoreTimer_activate
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
groupId | required | EML Group ID | --- |
neId | required | EML Network Element ID | --- |
clickedEntity | required | OSU Shelf Access Identifier | --- |
category | required | PAE Category | [EQPT] |
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | asapArray | array[PAEDetail] |
--- |
Return type
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/json
Example Request Data
Create : -------- /pae/paeSet/shelforCardLevel/100/5/SHELF-1/eqptPAECreate Payload: [{slotA: "slot_OPSOSM-10-3_OPSOSM-11-4", slotZ: "_true_10_true"}] Modify: ------ /pae/paeSet/shelforCardLevel/100/5/SHELF-1/eqptPAEEdit PayLoad: [{slotA: "slot_OPSOSM-5-2_OPSOSM-5-5", slotZ: "paeDesc_10_false_false"}] Delete: -------- /pae/paeSet/shelforCardLevel/100/5/SHELF-1/eqptPAEDeactivate PayLoad: [{slotA: "slot_OPSOSM-10-3_OPSOSM-11-4", slotZ: ""}]
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> </Status>
Tags
[ EQM ]
Operation
get /pae/paeGet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category}
Retrieves the Shelf and Card PAE Entity for 1830VWM. (retriveShelforCardLevelPAE : /pae/paeGet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category})
The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830 VWM Network Element retrieved from the call /data/npr/nes .
The 'clickedEntity' field value is Shelf or Card access identifier which can be obtained from the 'aid' field of any Shelf/Card equipment retrieved from the call /eqm/Equipment/All/{grpID}/{neID}.
The 'clickedEntity' field value is Shelf or Card access identifier which can be obtained from the 'aid' field of any Shelf/Card equipment retrieved from the call /eqm/Equipment/All/{grpID}/{neID}.
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
groupId | required | EML Group ID | --- |
neId | required | EML Network Element ID | --- |
clickedEntity | required | Entity Type : OSU Shelf Identifier | --- |
category | required | PAE Category | [EQPT] |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
PAEDetail
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/pae/paeGet/shelforCardLevel/100/5/SHELF-1/EQPT
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
Example Response Data
<Status> <opStatus> SUCCESS </opStatus> </Status>
Tags
[ EQM ]
PAEDetail
Name |
Type |
Description |
Enum |
---|---|---|---|
slotA | String string |
Slot A | --- |
slotZ | String string |
Slot Z | --- |
activate | String string |
Activate Status | --- |
descr | String string |
PAE Description | --- |
revertive | String string |
Revertive Status | --- |
paeStatus | String string |
PAE Status | --- |
wtrTimer | String string |
Wait to Restore Timer | --- |
wtrTimerRemain | String string |
Wait to Restore Timer Remain | --- |
clearWtrTimer | String string |
--- | --- |
uid | String string |
UID for Index | --- |