Enter some text to search
Search Results
- Overview
- SIS
- Architecture
- API Specifications
- Data Model
- Requesters
- Providers
- API Authorization
- GSEM Agreement
- FAQ
- Requester
- GET gsem
- GET message
- POST message
- PATCH message
- Provider
- GET gsem
- GET message
- POST message
- PATCH message
- Requestor
- Push Message
- Provider
- Push Message
- POST Upload
- GET Download
- GET Skills
- GET Task List
Pull/Poll
Push
Attachment API
Skills API
Outage/BCP API
POST redfish/v1/message
The POST message is an API that can be used to POST a transaction to GSEM Engine. The Requester can initiate the following transactions. Please click on specific transactions to get more details on the Interface I/O parameters.
POST redfish/v1/message
The POST message is an API that can be used to POST a transaction to GSEM Engine. The Provider can initiate the following transactions. Please click on specific transactions to get more details on the Interface I/O parameters.
-
GET redfish/v1/gsem
Returns a collection of Requesters and Providers with associated authorized connection to exchange case with. This API also returns a list of all the AgentKeys, AgentTypes, AgentNames and corresponding RemoteAgentNames.
Request HeadersContentType application/json Request Bodynone.AuthorizationPlease click here for details on Authorization.
Response BodyThe following table indicates the values/objects of the GSEM API returns in the response.
Collection of Requesters and Providers will contain the following values/objectsRequesters Collection of Requesters Providers Collection of Providers Id Unique Identifier eCPControl Contains transactionStatus and transactionStatusCode QueueDetails Contains details of the message queue
Queue details will contain the following values/objectsAgentKey Confidential key that identifies the Agent CHS that is sending the transaction. AgentName Name identifying the CHS which sends the transaction. AgentType Type of CHS that is sending the transaction. RemoteAgentNames Collection of AgentNames to which the transaction is sent to. Status Last message status of the queue. WaitingTime Waiting time of the queue. LastGetMessage Last get message. MessageCount Number of messages. LastSubmitMessage Last submitted message. NextMessageDate Date of the next message. ApplicationName Name of the application. TrafficLight Additional InfoBelow table describes different status codes that will be received after processing GSEM
Transaction Status Code
Transaction Status
Description
0
Success
The request has been processed successfully.
2
Invalid context, EventID
The request has been sent with a wrong parameters combination in authentication, JSON syntax, or content validation.
The returned EventID will have to be supplied to report problems to GSEM support.
ExamplesRequest
https://{appl}/redfish/v1/gsemResponse
{ "AgentList": [ { "Requester": [ { "AgentName": "LOOP_TEST_DEV_R1", "AgentKey": "mg1Lpae(uk)HeD1(d2mI", "AgentType": "HPE", "RemoteAgentNames": [ "LOOP_TEST_DEV_P1" ], "QueueDetails": { "Status": "", "WaitingTime": "3266836", "LastGetMessage": "6/2/2016 6:43:41 AM", "MessageCount": "17", "LastAckMessage": "6/2/2016 6:01:15 AM", "LastSubmitMessage": "5/7/2016 5:42:23 PM", "NextMessageDate": "4/25/2016 11:20:03 AM", "ApplicationName": "loop test app", "TrafficLight": "1" } }, { "AgentName": "Cloud_API_DEV_R", "AgentKey": "RobydbJgK7YugYK7YugY", "AgentType": "HPE", "RemoteAgentNames": [ "Cloud_API_DEV_P", "Arthur_HPE_Partner_P1", "Paul_SFDC_ExtP" ], "QueueDetails": { "Status": "", "WaitingTime": "675063", "LastGetMessage": "6/1/2016 10:44:33 AM", "MessageCount": "3", "LastAckMessage": "5/30/2016 9:13:14 AM", "LastSubmitMessage": "5/31/2016 10:31:19 AM", "NextMessageDate": "5/25/2016 11:16:16 AM", "ApplicationName": "GSEM Cloud API", "TrafficLight": "1" } }, { "AgentName": "Cloud_API_ITG_DEV_R", "AgentKey": "AFj(fpj(fpj(fpj(fpj(", "AgentType": "HPE", "RemoteAgentNames": [ "Cloud_API_ITG_DEV_P" ], "QueueDetails": { "Status": "", "WaitingTime": "", "LastGetMessage": "5/31/2016 10:41:39 AM", "MessageCount": "", "LastAckMessage": "5/31/2016 10:41:17 AM", "LastSubmitMessage": "5/31/2016 10:36:36 AM", "NextMessageDate": "", "ApplicationName": "GSEM Cloud API", "TrafficLight": "1" } }, { "AgentName": "Cloud_API_ITG_SIT_R", "AgentKey": "H2qC)wpSrcH2qC)wpSrc", "AgentType": "HPE", "RemoteAgentNames": [ "Cloud_API_ITG_SIT_P" ], "QueueDetails": { "Status": "", "WaitingTime": "2068", "LastGetMessage": "6/2/2016 6:34:42 AM", "MessageCount": "2", "LastAckMessage": "5/27/2016 8:53:08 AM", "LastSubmitMessage": "6/2/2016 6:10:26 AM", "NextMessageDate": "6/2/2016 6:12:51 AM", "ApplicationName": "GSEM Cloud API", "TrafficLight": "1" } }, { "AgentName": "Cloud_API_ITG_UAT_R", "AgentKey": "wQ95tzD)wQ95tzD)wQbU", "AgentType": "HPE", "RemoteAgentNames": [ "Cloud_API_ITG_UAT_P" ], "QueueDetails": { "Status": "", "WaitingTime": "", "LastGetMessage": "5/26/2016 5:08:52 AM", "MessageCount": "", "LastAckMessage": "5/26/2016 5:08:28 AM", "LastSubmitMessage": "5/26/2016 5:10:53 AM", "NextMessageDate": "", "ApplicationName": "GSEM Cloud API", "TrafficLight": "1" } }, { "AgentName": "Cloud_API_ITG_SIT_R2", "AgentKey": "DEV385V385V385V385VK", "AgentType": "CUSTOMER", "RemoteAgentNames": [ "Cloud_API_ITG_SIT_P2", "SFDC_Test_P004" ], "QueueDetails": { "Status": "", "WaitingTime": "4407274", "LastGetMessage": "5/10/2016 1:43:00 PM", "MessageCount": "5", "LastAckMessage": "4/13/2016 7:36:10 PM", "LastSubmitMessage": "4/12/2016 5:46:07 AM", "NextMessageDate": "4/12/2016 6:32:45 AM", "ApplicationName": "GSEM Cloud API", "TrafficLight": "1" } } ], "Provider": [ { "AgentName": "LOOP_TEST_DEV_P1", "AgentKey": "TUL9sAKosAKosAQ2Nd(c", "AgentType": "HPE", "RemoteAgentNames": [ "LOOP_TEST_DEV_R1" ], "QueueDetails": { "Status": "", "WaitingTime": "3261478", "LastGetMessage": "5/5/2016 7:04:46 AM", "MessageCount": "10", "LastAckMessage": "4/25/2016 12:50:49 PM", "LastSubmitMessage": "4/25/2016 12:50:49 PM", "NextMessageDate": "4/25/2016 12:49:21 PM", "ApplicationName": "loop test app", "TrafficLight": "1" } }, { "AgentName": "Cloud_API_DEV_P", "AgentKey": "TWWCTWWCTWWwUQh(UQh(", "AgentType": "HPE", "RemoteAgentNames": [ "Cloud_API_DEV_R", "Arthur_Customer_R2" ], "QueueDetails": { "Status": "", "WaitingTime": "", "LastGetMessage": "6/2/2016 6:46:41 AM", "MessageCount": "", "LastAckMessage": "5/31/2016 10:32:43 AM", "LastSubmitMessage": "5/31/2016 10:32:43 AM", "NextMessageDate": "", "ApplicationName": "GSEM Cloud API", "TrafficLight": "1" } }, { "AgentName": "Cloud_API_ITG_DEV_P", "AgentKey": "UlBDvmyxIlm3BDvmyxv4", "AgentType": "HPE", "RemoteAgentNames": [ "Cloud_API_ITG_DEV_R", "Paul_SFDC_IntR" ], "QueueDetails": { "Status": "", "WaitingTime": "", "LastGetMessage": "5/31/2016 10:45:07 AM", "MessageCount": "", "LastAckMessage": "5/31/2016 10:37:34 AM", "LastSubmitMessage": "5/31/2016 10:37:35 AM", "NextMessageDate": "", "ApplicationName": "GSEM Cloud API", "TrafficLight": "1" } }, { "AgentName": "Cloud_API_ITG_SIT_P", "AgentKey": "ebX5Tp1eTp1eTp1eTp1e", "AgentType": "HPE", "RemoteAgentNames": [ "Cloud_API_ITG_SIT_R" ], "QueueDetails": { "Status": "", "WaitingTime": "", "LastGetMessage": "6/2/2016 6:47:05 AM", "MessageCount": "", "LastAckMessage": "6/2/2016 6:15:39 AM", "LastSubmitMessage": "6/2/2016 6:12:52 AM", "NextMessageDate": "", "ApplicationName": "GSEM Cloud API", "TrafficLight": "1" } }, { "AgentName": "Cloud_API_ITG_UAT_P", "AgentKey": "fKUQfKUQfKUQfKUQf6BP", "AgentType": "HPE", "RemoteAgentNames": [ "Cloud_API_ITG_UAT_R" ], "QueueDetails": { "Status": "", "WaitingTime": "", "LastGetMessage": "5/26/2016 5:03:41 AM", "MessageCount": "", "LastAckMessage": "5/26/2016 4:59:12 AM", "LastSubmitMessage": "5/26/2016 5:09:15 AM", "NextMessageDate": "", "ApplicationName": "GSEM Cloud API", "TrafficLight": "1" } }, { "AgentName": "Cloud_API_ITG_SIT_P2", "AgentKey": "GanPMzkrVQ28R(ZzUd3h", "AgentType": "PARTNER", "RemoteAgentNames": [ "Cloud_API_ITG_SIT_R2" ], "QueueDetails": { "Status": "", "WaitingTime": "", "LastGetMessage": "4/27/2016 1:06:05 PM", "MessageCount": "", "LastAckMessage": "4/13/2016 12:05:14 PM", "LastSubmitMessage": "3/29/2016 6:41:46 AM", "NextMessageDate": "", "ApplicationName": "GSEM Cloud API", "TrafficLight": "1" } } ], "eCPControl": { "ECPVersion": "1.0", "TransactionStatus": "Success", "TransactionStatusCode": "0" }, "id": "gsemtestcompcert.hpe.com" } ], "Agreement": { "LicenseAgreed": "True", "LicenseAgreedBy": "gsemtestcompcert.hpe.com", "LicenseAgreedDate": "5/27/2016 11:11:23 AM" }, "Platform": "ITG" } -
GET redfish/v1/message (GetMessage)
This Request is used to receive incoming transactions.
Request HeaderscontentType application/json AgentKey Confidential key that identifies the Agent CHS that is sending the transaction Request Bodynone.Response BodyThe following table indicates the values/objects of the GSEM API returns in the response.
Output Parameters
TransactionName eCPControl acknowledge SERVICE_INCIDENT Note : We use the HTTP ETag to cache the Message ID of the message in question. This is sent as part of the HTTP response during GET message.
Additional InfoIf there is no pending transaction, the request returns only TransactionStatusCode parameters with the appropriate value (See table below).
If the request has found a pending transaction, it returns a “0” transaction status code, the MessageID, the RemoteAgentName, the RemoteAgentType, the SERVICE_INCIDENT object (which contains the transaction data), and the TRANSACTION object (which contains the transaction ID).
The MessageID value will have to be reused in the corresponding AcknowledgeMessage request.
The table below provides the possible transaction status code values.
Transaction Status Code
Transaction Status
Description
0
Success
The request has successfully pulled a transaction.
2
Invalid context, EventID
The request has been sent with a wrong parameters combination in authentication, JSON syntax, or content validation.
The returned EventID will have to be supplied to report problems to GSEM support.
3
No pending transaction
No pending transactions are available in the queue.
5
Waiting for Delay expiration
The GetMessage request has been submitted too quickly, which is related to the authorized polling rate.
The received SERVICE_INCIDENT content varies depending on the transaction that is received. For each transaction there is a set of mandatory and optional fields to be passed. Refer Requesters/Providers section for transaction overview details.
ExamplesExample1Example2Request
https://{appl}/redfish/v1/messageResponse (Example 1)
{ { "Acknowledge": "false", "TransactionName": "SERVICE REQUEST", "TransactionAgentKey": "TransactionAgentKey", "RemoteAgentName": "RemoteAgentName", "RemoteAgentType": "RemoteAgentType", "MessageID": "376591234", "SERVICE_INCIDENT": { "RequesterID": "5372536543-532", "RequesterSeverity": "MAJOR", "CurrentState": "NOT ENTITLED", "SERVICE_REQUESTER": { "ORGANIZATION": { "OrganizationName": "OrganizationName", "ADDRESS": { "AddressType": "PRIMARY", "GeoAddress1": "XYZ", "GeoAddress2": "", "City": "XYZ", "Region": "AV", "PostalCode": "123456", "TimeZone": "XYZ", "Country": "US" } }, "PERSON": { "FirstName": "XYZ", "LastName": "ABC", "ContactType": "LG=English", "ADDRESS": { "LOCATION": [ { "ID": "1-248-1234567", "Type": "PRIMARY_VOICE" }, { "ID": "124812345678", "Type": "ALTERNATE_VOICE" }, { "Type": "FAX" }, { "ID": "xyz.abc@xyz.com", "Type": "EMAIL" } ] } } }, "AGREEMENT": { "ContractID": "104961440344", "AgreementType": "LN=;DT=2023-04-03 23:27:42;PN=H6Z14B;SN=2MT850A5K5;RI=USA-PR-SOUTHEAST;LG=English" }, "Activity": [ { "ActionLog": "Service_Incident Submission", "LocalDate": "2023-04-04 03:40:24,2023-04-04 03:40:24", "ParameterList": "Service_Incident:Create", "NameValuePairList": { "eCPExtMessage_eCPExtControl_Version": "1.0", "eCPExtMessage_eCPExtControl_Name": "SDK Extension", "eCPExtMessage_EXT_SERVICE_INCIDENT_MaintenanceWindowFlag": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_OrderTypeCode": "05R", "eCPExtMessage_EXT_SERVICE_INCIDENT_AssetLocationDetails": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_FirstName": "Jean", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_LastName": "Benoit", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_ADDRESS_LOCATION_Type": "PRIMARY_VOICE", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_ADDRESS_LOCATION_ID": "+1-571-123-1234", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_ADDRESS_LOCATION1_Type": "EMAIL", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_ADDRESS_LOCATION1_ID": "xyz.abc@xyz.com", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_SpecialAccessOnsiteResources": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_LatestServiceDeliveryTime": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_GuaranteedFixTime": "2023-04-03 19:16:00", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EntitlementSummary": "Tech Care Critical - (HPE Tech Care Critical wDMR SVC) - HPE Hardware Tech Support 6HR Repair / 24X7; Defective Media Retention| Outage Management | Ship To : US | CON End Date : 2024-03-31", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_Coverage": "24x7", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EntitlementSLAResponse": "REPAIR_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_CoverageResponse": "6HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EstimatedDeliveryDays": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EstimatedDeliveryHours": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EstimatedDeliveryMinutes": "57", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_AdvisoryNumber": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_AdvisoryURL": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_RequestedServiceWindowStartTime": "2023-04-04 13:00:00", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_Description": "HPE Hardware Tech Support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_PackageDescription": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_Description": "GIS_TCHW_PARTS", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_Value": "Y", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EntitlementType": "C", "eCPExtMessage_EXT_SERVICE_INCIDENT_CaseOrigin": "CEP", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICEDELIVERY_TaskType": "Repair", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL1Name": "Storage", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL2Name": "Disk Storage Systems", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL3Name": "3PAR StoreServ Storage", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL4Name": "3PAR StoreServ Storage", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL5Name": "HPE 3PAR StoreServ 8000 Storage", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL6Name": "HPE 3PAR StoreServ 8000 Storage", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL1OID": "12169", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL2OID": "304617", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL3OID": "5347711", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL4OID": "5346921", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL5OID": "8737813", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL6OID": "1008632545", "eCPExtMessage_EXT_SERVICE_INCIDENT_PSAProjectID": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_DispatchedDateTime": "2023-04-04 03:40:18", "eCPExtMessage_EXT_SERVICE_INCIDENT_Location_ResidentLocation": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_Location_Resident24X7": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_PL": "4A", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICEDELIVERY_SKILLSET_SkillName": "3PAR StoreServ Storage_5347711_P", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICEDELIVERY_SKILLSET_SkillLevel": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICEDELIVERY_SKILLSET1_SkillName": "Break-Fix and Repair", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICEDELIVERY_SKILLSET1_SkillLevel": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER": "CONTRACT_TYPE", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER_Description": "Tech Care", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER_Value1": "TC", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER1": "GIS_TCHW_MATERIAL_HANDLING", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER1_Description": "Defective Media Retention", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER1_Value1": "DEF", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER1_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER2": "DELIVERY_METHOD", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER2_Description": "Onsite support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER2_Value1": "ONS", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER2_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER3": "GIS_TCHW_TRAVEL_ZONE", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER3_Description": "Travel Zone 1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER3_Value1": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER3_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER4": "COV_WINDOW7", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER4_Description": "24hrs, 7 days coverage", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER4_Value1": "24", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER4_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER5": "GIS_TCHW_SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER5_Description": "Service Level Key", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER5_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER5_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER6": "REPAIR_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER6_Description": "6hr Call to Repair", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER6_Value1": "6HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER6_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER7": "RESPONSE_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER7_Description": "4hr onsite response", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER7_Value1": "4HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER7_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER8": "SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER8_Description": "Critical Support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER8_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER8_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER9": "CONTRACT_TYPE", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER9_Description": "Tech Care", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER9_Value1": "TC", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER9_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER10": "GIS_TCHW_MATERIAL_HANDLING", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER10_Description": "Defective Media Retention", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER10_Value1": "DEF", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER10_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER11": "DELIVERY_METHOD", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER11_Description": "Onsite support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER11_Value1": "ONS", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER11_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER12": "GIS_TCHW_TRAVEL_ZONE", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER12_Description": "Travel Zone 1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER12_Value1": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER12_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER13": "COV_WINDOW7", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER13_Description": "24hrs, 7 days coverage", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER13_Value1": "24", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER13_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER14": "GIS_TCHW_SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER14_Description": "Service Level Key", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER14_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER14_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER15": "REPAIR_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER15_Description": "6hr Call to Repair", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER15_Value1": "6HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER15_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER16": "RESPONSE_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER16_Description": "4hr onsite response", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER16_Value1": "4HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER16_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER17": "SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER17_Description": "Critical Support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER17_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER17_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER18": "COV_WINDOW7", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER18_Description": "24hrs, 7 days coverage", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER18_Value1": "24", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER18_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER19": "GIS_TCHW_SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER19_Description": "Service Level Key", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER19_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER19_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER20": "REPAIR_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER20_Description": "6hr Call to Repair", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER20_Value1": "6HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER20_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER21": "RESPONSE_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER21_Description": "4hr onsite response", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER21_Value1": "4HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER21_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER22": "SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER22_Description": "Critical Support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER22_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER22_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/Td0ay6TN5hCZYRpyETnby2hQJwG3%2Fiwz5mp7YHT%2FNpg=/DMV9vh%2F%2F2ThRGcx9uwggnbK9KYfy4YKrPLyDtj41TfY=/Q3kWvxrCEVjbiZbnpmYcH9yWIyt1%2FbDA1Wx7RYHgYNs=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT1_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/e+R5zZBeiPo+f3i+ZLt5KWZ7Y02eACaakcMFkziiAmE=/3lpGGYm3H%2FBqu3r5R4XNppV1%2FgdGMayScGlrXQOne2c=/PXEGweWzdvMOIg%2FBUs3cPAFEObeimdDNbBWWOiIy%2Feg=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT2_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/7oHK%2FZwNuDloZ5XZJut5xplcGNmn8AnBWqN%2FQ4ywkNw=/7E2zsz7n9ybVV7EX4heRTIGmyU2sruKgGWh0bwGD76c=/K6l01SFKUdysVOtTZo%2FNEAHXTn9FRO%2FJUlM3rATHjnY=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT3_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/UF7GT8IEe1zjSl%2FamsZVeVIfPhVfHN6PGw4rRFP6DHA=/8G7n0Ex5+Vgo7uOUOva%2Ft5imegfqKFbxdsscCM9j5TQ=/28DMuUkhhKaT7vOuiaKuNkCdv4gr%2F9jDkhxiRrYdWMU=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT4_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/NgYgyCumS08HjGItyVCujprCvElmnSzWDo4jwY6EDpM=/aWPXHJUcRB7YIQMcHd3M69PNpCZF%2FHDhc3+lKucPYJo=/g+pni9jLL%2FWQ2BYKKmadRevsu7ztDeSN25MHCZtm%2FjY=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT5_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/KLFhcZQHlrtSGVF5+pZhj5VneK+jRhZ3H0u7bE5Zuhk=/gjFMO8MsKFisrZ0aGqXuhWcgUb1Uj9QMpCbxC3ymZuM=/wNhPz%2F4UQm%2FE75OeHbT6u3GvL0DLwsnxV7c+4xGnIdg=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT6_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/Lj8iTizlRbzb9GA3hlC8vcv%2FuD7Jxo4qEn2fYVqnMbc=/%2Fl+VGg0Ff7YxTukPreSnl60LLIRatA8lvRoy1K1CSzI=/VUimyDoLMClKk1AIWSkefK+mp6hxT5vLc34OHsGiEDE=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT7_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/z13audbpnOqzEH6n8R8b+Aet7Ep7A7ubDIAVwDHlxkg=/OlB+0gEnfDsFrsI2vOfi1Snv20CTV%2Fu1kXJ6qEI73vU=/vR6JsTjm+shllAUijqtJ0M7cNJsWNVM1xHTuZ7LIwfY=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT8_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/uJWKuUHjbzObunVwRDWh8%2FM1Ecy1tljgU2M0VpKBRLc=/EkhBprBHun2JtXtsyjA8wReg9zqoUXedSTcpwWudTIQ=/++dDqkzoFqu95yrRTclzfZVICakc7klost94U8FF2Cg=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT9_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/xhJpSOosLFsY%2FvVSQfLNwfbg4j%2FwIdvjYZMPK9NXVCo=/MahWLOXTjAqVJf8Gl6D5dIHwZPng01sPGFkPPvMgjtk=/%2F3tqdms0FDds4VWKP0BZPAV9D+5EBvu0lCG%2FlXbMQw0=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT10_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/M2Y3AxYZiAtVQNRg3+tN7rYFuuLRDRmzjG9w%2FoTOlzc=/J6XByH%2FGG4kuyty0AUDx2QL4mUHQJr+gigJXwziD+TM=/q+FgTrnN0cscAzRXjh%2FqxriY2ZT%2FPRe5rSlnhTLBTAI=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT11_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/lXENd1fAgxsdEQCl7ZpVMs43zyVVjo3pVyVH7kh9aSE=/T8Hh6IdAyk4+3hYi1BOT7L78TyDNn6nfPaZq4gh0MaY=/GHy9ZckQ1Sfsfpcv6QCSGdRTw3qsSk3xMB%2Fk6DHYcJg=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT12_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/tqcmAhU+iBon85gCX39ERxPKN4gLH8XinjEa4SKc2Ac=/INeLEuesmEq30Z9IngKogcR0vQODysGzOfNB609mPZ0=/sth%2FnLg4GNoD7McQunaDGjvWugA+fOpF6saMtSUZEZw=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT13_URL": "https://file-upload-download.itcs.hpe.com/download/chatter/ZwURqB1Dwc+eCymUrY+WOXGMYAm3GRTaAFCgNZl5QNg=/%2FY8ezeHw6xfZVbw+7F17Vq643bFw8OU540M0LqIjv0U=/vQ7DTUQRJ6iVk3POpryS0VcoG%2FVSvp%2FAJDSbRD+kmtc=" } } ] } }Response (Example 2)
{ "Acknowledge": "false", "TransactionName": "PROBLEM RESOLUTION", "TransactionAgentKey": "TransactionAgentKey", "RemoteAgentName": "RemoteAgentName", "RemoteAgentType": "HPE", "MessageID": "3247725", "SERVICE_INCIDENT": { "RequesterID": "RequesterID", "CurrentState": "CLOSED PENDING CONFIRMATION", "ProviderID": "532771234SS", "SOLUTION": { "REFERENCE": { "EXPRESSION": { "STATEMENT": [ { "StatementRole": "DESCRIPTION", "StatementText": "[Onsite Repair][Onsite Repair][Onsite][Replaced parts, issue resolved]Replaced parts, issue resolved" }, { "StatementRole": "TITLE", "StatementText": "Onsite Repair" } ] } } }, "Activity": [ { "ActionLog": "Problem Resolution", "LocalDate": "2022-08-03 17:22:09,2022-08-03 17:22:09", "ParameterList": "ServiceIncidentExt:Create;SISExtensions:Mapped:Solution:Create", "NameValuePairList": { "eCPExtMessage_eCPExtControl_Version": "1.0", "eCPExtMessage_eCPExtControl_Name": "SDK Extension", "eCPExtMessage_eCPExtControl_TransactionType": "4", "eCPExtMessage_ExtServiceIncident_Repair_RepairClass": "CO", "eCPExtMessage_ExtServiceIncident_Repair_RepairClassText": "Rpr,Compt,Parts Repl", "eCPExtMessage_ExtServiceIncident_Repair_DelayCode": "8", "eCPExtMessage_ExtServiceIncident_Repair_DelayCodeText": "Customer caused Delay", "eCPExtMessage_ExtServiceIncident_Repair_ServiceStartDateTime": "2022-08-03 16:49:55", "eCPExtMessage_ExtServiceIncident_Repair_SystemFixedTime": "2022-08-03 17:19:46", "eCPExtMessage_ExtServiceIncident_Repair_ServiceEndDateTime": "2022-08-03 17:19:46", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_InstalledPartNumber": "101920-001", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_InstalledSerialNumber": "FDHFISHDFI", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_InstalledPartDescription": "SPS-POWER SUPPLY,450W,OPAL", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_RemovedPartNumber": "101920-001", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_RemovedSerialNumber": "GRJGFKGNG", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_RemovedPartDescription": "SPS-POWER SUPPLY,450W,OPAL", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_InstalledPartNumber": "101920-001", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_InstalledSerialNumber": "IJHRJFGGD", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_InstalledPartDescription": "SPS-POWER SUPPLY,450W,OPAL", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_RemovedPartNumber": "101920-001", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_RemovedSerialNumber": "GRGEGREG", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_RemovedPartDescription": "SPS-POWER SUPPLY,450W,OPAL", "eCPExtMessage_ExtServiceIncident_Repair_RepairDuration": "00:30", "eCPExtMessage_ExtServiceIncident_Repair_TravelDuration": "00:27" } } ] }, "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } } -
GET redfish/v1/message (GetMessage)
This Request is used to receive incoming transactions .
Request HeaderscontentType application/json AgentKey Confidential key that identifies the Agent CHS that is sending the transaction Request Bodynone.Response BodyThe following table indicates the values/objects of the GSEM API returns in the response.
Output Parameters
TransactionName eCPControl acknowledge SERVICE_INCIDENT Note : We use the HTTP ETag to cache the Message ID of the message in question. This is sent as part of the HTTP response during GET message.
Additional InfoIf there is no pending transaction, the request returns only TransactionStatusCode parameters with the appropriate value (See table below).
If the request has found a pending transaction, it returns a “0” transaction status code, the MessageID, the RemoteAgentName, the RemoteAgentType, the SERVICE_INCIDENT object (which contains the transaction data), and the TRANSACTION object (which contains the transaction ID).
The MessageID value will have to be reused in the corresponding AcknowledgeMessage request.
The table below provides the possible transaction status code values.
Transaction Status Code
Transaction Status
Description
0
Success
The request has successfully pulled a transaction.
2
Invalid context, EventID
The request has been sent with a wrong parameters combination in authentication, JSON syntax, or content validation.
The returned EventID will have to be supplied to report problems to GSEM support.
3
No pending transaction
No pending transactions are available in the queue.
5
Waiting for Delay expiration
The GetMessage request has been submitted too quickly, which is related to the authorized polling rate.
The received SERVICE_INCIDENT content varies depending on the transaction that is received. For each transaction there is a set of mandatory and optional fields to be passed. Refer Requesters/Providers section for transaction overview details.
ExamplesExample1Example2Request
https://{appl}/redfish/v1/messageResponse (Example 1)
{ "Acknowledge": "false", "TransactionName": "PROVIDE PROBLEM INFORMATION", "TransactionAgentKey": "TransactionAgentKey", "RemoteAgentName": "RemoteAgentName", "RemoteAgentType": "HPE", "MessageID": "376594881", "SERVICE_INCIDENT": { "RequesterID": "5372432151-531", "RequesterSeverity": "MAJOR", "ResponseTime": "2023-04-04 21:00:00,2023-04-04 21:00:00", "CurrentState": "OPEN PROVIDER", "Comment": "Entitlement", "ProviderID": "HPE_US.281234", "Activity": [ { "ActionLog": "Provide Problem Information", "LocalDate": "2023-04-04 03:38:32,2023-04-04 03:38:32", "NameValuePairList": { "eCPExtMessage_eCPExtControl_Version": "1.0", "eCPExtMessage_eCPExtControl_Version": "1.0", "eCPExtMessage_eCPExtControl_Name": "SDK Extension", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PartOrderNumber": "5372432151-531-1", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_LogisticsOrderNumber": "0640857070", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_OrganizationName": "OrganizationName", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_ADDRESS_GeoAddress1": "2200 s. 114th St.", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_ADDRESS_City": "WEST ALLIS", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_ADDRESS_Country": "US", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_ADDRESS_Region": "WI", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_ADDRESS_PostalCode": "53227", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_ReceivedInstructions": "Customer Reference ID:eae6ea9e-3e83-4c30-b", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_LineItemID": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_PartNumber": "819413-001", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_PartDescription": "SPS-MEMORY DIMM 64GB PC4-2400T-L 2Gx4", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_ETA": "2023-04-04 03:30:00", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_PartStatus": "Shipped", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_InterveneFlag": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_CarrierID": "UPSN", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_ShipDate": "2023-04-04 03:32:39", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_TrackingNumber": "1Z4295AR0118663003", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_SourcedLocation": "C299FG21", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_RMANumber": "100027680764322251", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_DMRFlag": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_CSRCode": "A", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_ReturnableCode": "A" } } ] }, "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } }Response (Example 2)
{ "Acknowledge": "false", "TransactionName": "PROBLEM RESOLUTION", "TransactionAgentKey": "TransactionAgentKey", "RemoteAgentName": "RemoteAgentName", "RemoteAgentType": "HPE", "MessageID": "324123", "SERVICE_INCIDENT": { "RequesterID": "RequesterID", "CurrentState": "CLOSED PENDING CONFIRMATION", "ProviderID": "ProviderID", "SOLUTION": { "REFERENCE": { "EXPRESSION": { "STATEMENT": [ { "StatementRole": "DESCRIPTION", "StatementText": "[Onsite Repair][Onsite Repair][Onsite][Replaced parts, issue resolved]Replaced parts, issue resolved" }, { "StatementRole": "TITLE", "StatementText": "Onsite Repair" } ] } } }, "Activity": [ { "ActionLog": "Problem Resolution", "LocalDate": "2022-08-03 17:22:09,2022-08-03 17:22:09", "ParameterList": "ServiceIncidentExt:Create;SISExtensions:Mapped:Solution:Create", "NameValuePairList": { "eCPExtMessage_eCPExtControl_Version": "1.0", "eCPExtMessage_eCPExtControl_Name": "SDK Extension", "eCPExtMessage_eCPExtControl_TransactionType": "4", "eCPExtMessage_ExtServiceIncident_Repair_RepairClass": "CO", "eCPExtMessage_ExtServiceIncident_Repair_RepairClassText": "Rpr,Compt,Parts Repl", "eCPExtMessage_ExtServiceIncident_Repair_DelayCode": "8", "eCPExtMessage_ExtServiceIncident_Repair_DelayCodeText": "Customer caused Delay", "eCPExtMessage_ExtServiceIncident_Repair_ServiceStartDateTime": "2022-08-03 16:49:55", "eCPExtMessage_ExtServiceIncident_Repair_SystemFixedTime": "2022-08-03 17:19:46", "eCPExtMessage_ExtServiceIncident_Repair_ServiceEndDateTime": "2022-08-03 17:19:46", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_InstalledPartNumber": "101920-001", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_InstalledSerialNumber": "FDHFISHDFI", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_InstalledPartDescription": "SPS-POWER SUPPLY,450W,OPAL", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_RemovedPartNumber": "RemovedPartNumber", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_RemovedSerialNumber": "RemovedSerialNumber", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_RemovedPartDescription": "SPS-POWER SUPPLY,450W,OPAL", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_InstalledPartNumber": "101920-001", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_InstalledSerialNumber": "IJHRJFGGD", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_InstalledPartDescription": "SPS-POWER SUPPLY,450W,OPAL", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_RemovedPartNumber": "101920-001", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_RemovedSerialNumber": "GRGEGREG", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_RemovedPartDescription": "SPS-POWER SUPPLY,450W,OPAL", "eCPExtMessage_ExtServiceIncident_Repair_RepairDuration": "00:30", "eCPExtMessage_ExtServiceIncident_Repair_TravelDuration": "00:27" } } ] }, "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } } -
POST redfish/v1/message (Service Request)
The Service Request transaction is the first transaction for a Service Incident. It initiates the flow by sending initial data to GSEM Engine. The main purpose of this transaction is to pass contractual information and contact information.
Request HeadersThe AgentKey parameter is required for authentication purpose.
ContentType application/json AgentKey A string value specifying the transaction agent key. Request BodyThe Requester has to send an object called Message. The Message contains two fields (RemoteAgentName and TransactionName) and one JSON object (ServiceIncident). The RemoteAgentName parameter is required for routing purpose. These parameters are specific to each CHS and are provided by the GSEM System administrator.
Below table gives what is Mandatory values/objects to be sent while sending the Service Request.
Input Parameters
Required (Yes / No)
RemoteAgentName Yes
TransactionName Yes
SERVICE_INCIDENT StopOnConversion Flag to indicate whether to submit the transaction or not when the NameValuePair list mapping to eCPExtMessage generates a warning. The default value is false. Response BodyThe following table indicates the values/objects returned by GSEM Engine.
Output Parameters
TransactionName eCPControl eCPVersion
TransactionStatusCode
TransactionStatus
Additional InfoUpon reception, the GSEM Engine proceeds to the authentication checking and syntax validation of the message (JSON format) and also for validation of the transaction content (mandatory fields, fields format).
After processing the request, the GSEM Engine returns a TransactionStatusCode and a SERVICE_INCIDENT object with State, Comment, Entitled, and Acknowledge values.
The table below provides the possible transaction status code values.
Transaction Status Code
Transaction Status
Description
0
Success
The request has been processed successfully.
1
Duplicate ID
A Service Incident has already been submitted with the same RequesterID for the same Requester.
This status code is only returned when submitting a Service_Request transaction.
2
Invalid context, EventID
The request has been sent with a wrong parameters combination in authentication, JSON syntax, or content validation.
The returned EventID will have to be supplied to report problems to GSEM support.
4
Already processed
The GSEM Engine has already processed this transaction successfully.
Important note: It must never be assumed the transaction has been correctly processed, for receiving an incomplete return, or not receiving a return (for example, in case of a network failure). Therefore, in uncertain contexts, the transaction must be resubmitted until getting a “0” or “4” status.
ExamplesRequest
{ { "Acknowledge": "false", "TransactionName": "SERVICE REQUEST", "TransactionAgentKey": "TransactionAgentKey", "RemoteAgentName": "RemoteAgentName", "RemoteAgentType": "RemoteAgentType", "MessageID": "376591234", "SERVICE_INCIDENT": { "RequesterID": "5372536543-532", "RequesterSeverity": "MAJOR", "CurrentState": "NOT ENTITLED", "SERVICE_REQUESTER": { "ORGANIZATION": { "OrganizationName": "OrganizationName", "ADDRESS": { "AddressType": "PRIMARY", "GeoAddress1": "XYZ", "GeoAddress2": "", "City": "XYZ", "Region": "AV", "PostalCode": "123456", "TimeZone": "XYZ", "Country": "US" } }, "PERSON": { "FirstName": "XYZ", "LastName": "ABC", "ContactType": "LG=English", "ADDRESS": { "LOCATION": [ { "ID": "1-248-1234567", "Type": "PRIMARY_VOICE" }, { "ID": "124812345678", "Type": "ALTERNATE_VOICE" }, { "Type": "FAX" }, { "ID": "xyz.abc@xyz.com", "Type": "EMAIL" } ] } } }, "AGREEMENT": { "ContractID": "104961440344", "AgreementType": "LN=;DT=2023-04-03 23:27:42;PN=H6Z14B;SN=2MT850A5K5;RI=USA-PR-SOUTHEAST;LG=English" }, "Activity": [ { "ActionLog": "Service_Incident Submission", "LocalDate": "2023-04-04 03:40:24,2023-04-04 03:40:24", "ParameterList": "Service_Incident:Create", "NameValuePairList": { "eCPExtMessage_eCPExtControl_Version": "1.0", "eCPExtMessage_eCPExtControl_Name": "SDK Extension", "eCPExtMessage_EXT_SERVICE_INCIDENT_MaintenanceWindowFlag": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_OrderTypeCode": "05R", "eCPExtMessage_EXT_SERVICE_INCIDENT_AssetLocationDetails": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_FirstName": "Jean", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_LastName": "Benoit", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_ADDRESS_LOCATION_Type": "PRIMARY_VOICE", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_ADDRESS_LOCATION_ID": "+1-571-123-1234", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_ADDRESS_LOCATION1_Type": "EMAIL", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_ADDRESS_LOCATION1_ID": "xyz.abc@xyz.com", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_SpecialAccessOnsiteResources": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_LatestServiceDeliveryTime": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_GuaranteedFixTime": "2023-04-03 19:16:00", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EntitlementSummary": "Tech Care Critical - (HPE Tech Care Critical wDMR SVC) - HPE Hardware Tech Support 6HR Repair / 24X7; Defective Media Retention| Outage Management | Ship To : US | CON End Date : 2024-03-31", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_Coverage": "24x7", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EntitlementSLAResponse": "REPAIR_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_CoverageResponse": "6HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EstimatedDeliveryDays": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EstimatedDeliveryHours": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EstimatedDeliveryMinutes": "57", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_AdvisoryNumber": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_AdvisoryURL": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_RequestedServiceWindowStartTime": "2023-04-04 13:00:00", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_Description": "HPE Hardware Tech Support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_PackageDescription": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_Description": "GIS_TCHW_PARTS", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_Value": "Y", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EntitlementType": "C", "eCPExtMessage_EXT_SERVICE_INCIDENT_CaseOrigin": "CEP", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICEDELIVERY_TaskType": "Repair", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL1Name": "Storage", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL2Name": "Disk Storage Systems", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL3Name": "3PAR StoreServ Storage", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL4Name": "3PAR StoreServ Storage", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL5Name": "HPE 3PAR StoreServ 8000 Storage", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL6Name": "HPE 3PAR StoreServ 8000 Storage", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL1OID": "12169", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL2OID": "304617", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL3OID": "5347711", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL4OID": "5346921", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL5OID": "8737813", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL6OID": "1008632545", "eCPExtMessage_EXT_SERVICE_INCIDENT_PSAProjectID": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_DispatchedDateTime": "2023-04-04 03:40:18", "eCPExtMessage_EXT_SERVICE_INCIDENT_Location_ResidentLocation": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_Location_Resident24X7": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_PL": "4A", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICEDELIVERY_SKILLSET_SkillName": "3PAR StoreServ Storage_5347711_P", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICEDELIVERY_SKILLSET_SkillLevel": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICEDELIVERY_SKILLSET1_SkillName": "Break-Fix and Repair", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICEDELIVERY_SKILLSET1_SkillLevel": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER": "CONTRACT_TYPE", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER_Description": "Tech Care", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER_Value1": "TC", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER1": "GIS_TCHW_MATERIAL_HANDLING", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER1_Description": "Defective Media Retention", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER1_Value1": "DEF", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER1_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER2": "DELIVERY_METHOD", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER2_Description": "Onsite support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER2_Value1": "ONS", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER2_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER3": "GIS_TCHW_TRAVEL_ZONE", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER3_Description": "Travel Zone 1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER3_Value1": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER3_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER4": "COV_WINDOW7", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER4_Description": "24hrs, 7 days coverage", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER4_Value1": "24", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER4_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER5": "GIS_TCHW_SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER5_Description": "Service Level Key", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER5_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER5_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER6": "REPAIR_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER6_Description": "6hr Call to Repair", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER6_Value1": "6HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER6_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER7": "RESPONSE_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER7_Description": "4hr onsite response", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER7_Value1": "4HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER7_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER8": "SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER8_Description": "Critical Support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER8_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER8_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER9": "CONTRACT_TYPE", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER9_Description": "Tech Care", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER9_Value1": "TC", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER9_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER10": "GIS_TCHW_MATERIAL_HANDLING", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER10_Description": "Defective Media Retention", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER10_Value1": "DEF", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER10_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER11": "DELIVERY_METHOD", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER11_Description": "Onsite support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER11_Value1": "ONS", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER11_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER12": "GIS_TCHW_TRAVEL_ZONE", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER12_Description": "Travel Zone 1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER12_Value1": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER12_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER13": "COV_WINDOW7", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER13_Description": "24hrs, 7 days coverage", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER13_Value1": "24", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER13_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER14": "GIS_TCHW_SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER14_Description": "Service Level Key", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER14_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER14_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER15": "REPAIR_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER15_Description": "6hr Call to Repair", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER15_Value1": "6HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER15_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER16": "RESPONSE_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER16_Description": "4hr onsite response", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER16_Value1": "4HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER16_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER17": "SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER17_Description": "Critical Support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER17_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER17_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER18": "COV_WINDOW7", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER18_Description": "24hrs, 7 days coverage", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER18_Value1": "24", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER18_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER19": "GIS_TCHW_SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER19_Description": "Service Level Key", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER19_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER19_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER20": "REPAIR_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER20_Description": "6hr Call to Repair", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER20_Value1": "6HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER20_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER21": "RESPONSE_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER21_Description": "4hr onsite response", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER21_Value1": "4HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER21_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER22": "SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER22_Description": "Critical Support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER22_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER22_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/Td0ay6TN5hCZYRpyETnby2hQJwG3%2Fiwz5mp7YHT%2FNpg=/DMV9vh%2F%2F2ThRGcx9uwggnbK9KYfy4YKrPLyDtj41TfY=/Q3kWvxrCEVjbiZbnpmYcH9yWIyt1%2FbDA1Wx7RYHgYNs=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT1_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/e+R5zZBeiPo+f3i+ZLt5KWZ7Y02eACaakcMFkziiAmE=/3lpGGYm3H%2FBqu3r5R4XNppV1%2FgdGMayScGlrXQOne2c=/PXEGweWzdvMOIg%2FBUs3cPAFEObeimdDNbBWWOiIy%2Feg=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT2_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/7oHK%2FZwNuDloZ5XZJut5xplcGNmn8AnBWqN%2FQ4ywkNw=/7E2zsz7n9ybVV7EX4heRTIGmyU2sruKgGWh0bwGD76c=/K6l01SFKUdysVOtTZo%2FNEAHXTn9FRO%2FJUlM3rATHjnY=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT3_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/UF7GT8IEe1zjSl%2FamsZVeVIfPhVfHN6PGw4rRFP6DHA=/8G7n0Ex5+Vgo7uOUOva%2Ft5imegfqKFbxdsscCM9j5TQ=/28DMuUkhhKaT7vOuiaKuNkCdv4gr%2F9jDkhxiRrYdWMU=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT4_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/NgYgyCumS08HjGItyVCujprCvElmnSzWDo4jwY6EDpM=/aWPXHJUcRB7YIQMcHd3M69PNpCZF%2FHDhc3+lKucPYJo=/g+pni9jLL%2FWQ2BYKKmadRevsu7ztDeSN25MHCZtm%2FjY=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT5_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/KLFhcZQHlrtSGVF5+pZhj5VneK+jRhZ3H0u7bE5Zuhk=/gjFMO8MsKFisrZ0aGqXuhWcgUb1Uj9QMpCbxC3ymZuM=/wNhPz%2F4UQm%2FE75OeHbT6u3GvL0DLwsnxV7c+4xGnIdg=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT6_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/Lj8iTizlRbzb9GA3hlC8vcv%2FuD7Jxo4qEn2fYVqnMbc=/%2Fl+VGg0Ff7YxTukPreSnl60LLIRatA8lvRoy1K1CSzI=/VUimyDoLMClKk1AIWSkefK+mp6hxT5vLc34OHsGiEDE=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT7_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/z13audbpnOqzEH6n8R8b+Aet7Ep7A7ubDIAVwDHlxkg=/OlB+0gEnfDsFrsI2vOfi1Snv20CTV%2Fu1kXJ6qEI73vU=/vR6JsTjm+shllAUijqtJ0M7cNJsWNVM1xHTuZ7LIwfY=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT8_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/uJWKuUHjbzObunVwRDWh8%2FM1Ecy1tljgU2M0VpKBRLc=/EkhBprBHun2JtXtsyjA8wReg9zqoUXedSTcpwWudTIQ=/++dDqkzoFqu95yrRTclzfZVICakc7klost94U8FF2Cg=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT9_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/xhJpSOosLFsY%2FvVSQfLNwfbg4j%2FwIdvjYZMPK9NXVCo=/MahWLOXTjAqVJf8Gl6D5dIHwZPng01sPGFkPPvMgjtk=/%2F3tqdms0FDds4VWKP0BZPAV9D+5EBvu0lCG%2FlXbMQw0=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT10_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/M2Y3AxYZiAtVQNRg3+tN7rYFuuLRDRmzjG9w%2FoTOlzc=/J6XByH%2FGG4kuyty0AUDx2QL4mUHQJr+gigJXwziD+TM=/q+FgTrnN0cscAzRXjh%2FqxriY2ZT%2FPRe5rSlnhTLBTAI=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT11_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/lXENd1fAgxsdEQCl7ZpVMs43zyVVjo3pVyVH7kh9aSE=/T8Hh6IdAyk4+3hYi1BOT7L78TyDNn6nfPaZq4gh0MaY=/GHy9ZckQ1Sfsfpcv6QCSGdRTw3qsSk3xMB%2Fk6DHYcJg=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT12_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/tqcmAhU+iBon85gCX39ERxPKN4gLH8XinjEa4SKc2Ac=/INeLEuesmEq30Z9IngKogcR0vQODysGzOfNB609mPZ0=/sth%2FnLg4GNoD7McQunaDGjvWugA+fOpF6saMtSUZEZw=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT13_URL": "https://file-upload-download.itcs.hpe.com/download/chatter/ZwURqB1Dwc+eCymUrY+WOXGMYAm3GRTaAFCgNZl5QNg=/%2FY8ezeHw6xfZVbw+7F17Vq643bFw8OU540M0LqIjv0U=/vQ7DTUQRJ6iVk3POpryS0VcoG%2FVSvp%2FAJDSbRD+kmtc=" } } ] } }Response
{ "TransactionName": "SERVICE REQUEST", "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" }bjectBuilderID": "HPE GSEMCLOUD R1" } } -
PATCH redfish/v1/message (AcknowledgeMessage)
This request is used to acknowledge the reception of a transaction.
Request HeaderscontentType application/json AgentKey Confidential key that identifies the Agent CHS that is sending the transaction ETag Message unique identifier. To be used by the agent to acknowledge the message Note : We use the HTTP ETag to cache the Message ID of the message in question. This is sent as part of the HTTP response during GET message. The same Message ID is sent back as part of Request Header during the subsequent PATCH call.
Request Bodynone.Response BodyThe following table indicates the values/objects of the GSEM API returns in the response.
Output Parameters Description acknowledge = true This field is to denote whether the message is acknowledged or not Additional InfoThe table below provides the possible transaction status code values.
Transaction Status Code
Transaction Status
Description
0
Success
The request has pulled a transaction successfully.
2
Invalid context, EventID
The request has been sent with a wrong parameters combination in authentication, JSON syntax, or content validation.
The returned EventID will have to be supplied to report problems to GSEM support.
ExamplesRequest
https://{appl}/redfish/v1/messageResponse
{ "Acknowledge": "true", "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } } -
POST Predfish/v1/message (Problem Submittal)
Once the SERVICE_INCIDENT is entitled by the Provider, the Problem Submittal transaction is used to pass problem information to the Provider. It contains at least RequesterSeverity, ResponseTime fields and the PROBLEM object. The PROBLEM object must contain one Title statement, and one Description statement. It can contain additional statement type.
Request HeadersAgentKey This Field is specifying the transaction agent key string mandatory Request BodyobjeCPMessage Which is an object for Input string MandatoryeCPControl Which is an Input message head part string OptionalECPVersion Identify the version of the API specification that is used. string MandatoryRemoteAgentName specifying the remote agent name for the transaction. string MandatoryTransactionStatus An expression evaluating to an object of type string MandatoryTransactionStatusCode An expression evaluating to an object of type string MandatoryTransactionType This field is for specifying for the transaction string MandatoryMessageID This field is for specifying the MessageId string OptionalRemoteAgentType An expression evaluating to an object of type string MandatoryMinWaitingTime Polling rate for the current agent. Returned in each GetMessage response Date Time MandatoryExamplesPOST: https://{appl}/redfish/v1/message AgentKey : (A8sYA8swaKACnKACnKA Request Body: {"objeCPMessage": { "eCPControl": { "ECPVersion": "1.0", "RemoteAgentName": "Test_RemoteAgentName", "TransactionStatus": "", "TransactionStatusCode": "0", "MessageID": "1861415", "RemoteAgentType": "2", "ObjectBuilderID": "HP ITSB SIS Engine V1.0", "MinWaitingTime": "null" }, "SERVICE_INCIDENT": { "RequesterID": "331834_011941356", "RequesterSeverity": "4", "ResponseTime": "2013-09-08 01:19:41,2013-09-08 01:19:41", "ProviderID": "", "ProviderPriority": "", "SERVICE_REQUESTER": { "ORGANIZATION": { "OrganizationName": "Huf Huelsbeck Fuerst GmbH", "ADDRESS": { "AddressType": "0", "GeoAddress1": "Address1", "GeoAddress2": "12345", "City": "City", "Region": "12345", "PostalCode": "12345", "Country": "ZW", "LOCATION": [ { "ID": "+31 123456789", "Type": "PRIMARY_VOICE" }, { "ID": "ab-razak.mohd-zain@hp.com", "Type": "EMAIL" } ] } }, "PERSON": { "FirstName": "Eric", "LastName": "Sonneveld", "ADDRESS": { "addressType": "", "geoAddress1": "", "geoAddress2": "", "city": "", "region": "", "postalCode": "", "country": "", "LOCATION": [ { "ID": "+31 123456789", "Type": "PRIMARY_VOICE" }, { "ID": "ab-razak.mohd-zain@hp.com", "Type": "PRIMARY_VOICE" } ] } } }, "AGREEMENT": { "ContractID": "CN=101394379133", "AgreementType": ";SN=12345;LN=PSID-151023;RI=EUD_SC NETW PNB;PN=Not Provided" }, "ACTIVITY": [{ "ActionLog": "Service_Incident Problem Submittal", "LocalDate": "2013-09-08 01:19:41,2013-09-08 01:19:41", "ParameterList": "Service_Incident:Update" }], "PROBLEM": { "Impact": "", "Likelihood": "", "EXPRESSION": { "Relation": "AND", "STATEMENT": [ { "StatementRole": "0", "StatementText": "0" }, { "StatementRole": "11", "StatementText": "3" } ] } } }, "TRANSACTION": { "TransactionType": "2" } } }Response BodyOutput Parameters
Return (Yes / No)
eCPControl eCPVersion
Yes
TransactionStatusCode
Yes
TransactionStatus
Yes
TransactionName
Yes
Examples{ @*"@@Odata.context": "https://{appl}/redfish/v1/$metadata#GSEMCloud.Models.ResposeData",*@"TransactionType": "", "TransactionAgentKey": "", "RemoteAgentName": "", "RemoteAgentType": "", "ID": "", "Acknowledgement": "", "SERVICE_INCIDENT": { "RequesterID": "", "RequesterSeverity": "", "ResponseTime": "", "ProviderID": "", "ProviderPriority": "", "SERVICE_REQUESTER": { "ORGANIZATION": { "OrganizationName": "Huf Huelsbeck Fuerst GmbH", "ADDRESS": { "AddressType": "", "GeoAddress1": "", "GeoAddress2": "", "City": "", "Region": "", "PostalCode": "", "Country": "", "LOCATION": [] } }, "PERSON": { "FirstName": "Eric", "LastName": "Sonneveld", "ADDRESS": { "addressType": "", "geoAddress1": "", "geoAddress2": "", "city": "", "region": "", "postalCode": "", "country": "", "LOCATION": [] } } }, "AGREEMENT": { "ContractID": "", "AgreementType": "" }, "ACTIVITY": [{ "ActionLog": "", "LocalDate": "", "ParameterList": "" }], "PROBLEM": { "Impact": "", "Likelihood": "", "EXPRESSION": { "Relation": "", "STATEMENT": [] } } }, "eCPControl": { "ECPVersion": "1.0", "TransactionStatus": "Ok", "TransactionStatusCode": "200", "ObjectBuilderID": "HP ITSB SIS Engine V1.0", "MinWaitingTime": "" } } -
POST redfish/v1/message (Provide Problem Information)
This transaction is used to provide additional information on the problem in an unsolicited way: ProviderPriority, ResponseTime, Comment, ACTIVITY, and SERVICE_PROVIDER objects can be modified. This transaction is used in particular to add an ACTIVITY instance in order to record a significant service delivery activity or event. If SERVICE_PROVIDER is modified, the entire object has to be submitted. The GSEM Engine replaces objects as a whole.
Request HeadersThe AgentKey parameter is required for authentication purpose.
ContentType application/json AgentKey A string value specifying the transaction agent key. Request BodyThe Requester has to send an object called Message. The Message contains two fields (RemoteAgentName and TransactionName) and one JSON object (ServiceIncident). The RemoteAgentName parameter is required for routing purpose. These parameters are specific to each CHS and are provided by the GSEM System administrator.
Below table gives what is Mandatory values/objects to be sent while sending the Provide Problem Information.
Input Parameters
Required (Yes / No)
RemoteAgentName
Yes
TransactionName Yes
SERVICE_INCIDENT StopOnConversion Flag to indicate whether to submit the transaction or not when the NameValuePair list mapping to eCPExtMessage generates a warning. The default value is false. Response BodyThe following table indicates the values/objects returned by GSEM Engine.
Output Parameters
TransactionName eCPControl eCPVersion
TransactionStatusCode
TransactionStatus
Additional InfoUpon reception, the GSEM Engine proceeds to the authentication checking and syntax validation of the message (JSON format) and also for validation of the transaction content (mandatory fields, fields format).
After processing the request, the GSEM Engine returns a TransactionStatusCode and a SERVICE_INCIDENT object with State, Comment, Entitled, and Acknowledge values.
The table below provides the possible transaction status code values.
Transaction Status Code
Transaction Status
Description
0
Success
The request has been processed successfully.
1
Duplicate ID
A Service Incident has already been submitted with the same RequesterID for the same Requester.
This status code is only returned when submitting a Service_Request transaction.
2
Invalid context, EventID
The request has been sent with a wrong parameters combination in authentication, JSON syntax, or content validation.
The returned EventID will have to be supplied to report problems to GSEM support.
4
Already processed
The GSEM Engine has already processed this transaction successfully.
Important note: It must never be assumed the transaction has been correctly processed, for receiving an incomplete return, or not receiving a return (for example, in case of a network failure). Therefore, in uncertain contexts, the transaction must be resubmitted until getting a “0” or “4” status.
ExamplesRequest (Example)
{ "Acknowledge": "false", "TransactionName": "PROVIDE PROBLEM INFORMATION", "TransactionAgentKey": "TransactionAgentKey", "RemoteAgentName": "RemoteAgentName", "RemoteAgentType": "HPE", "MessageID": "3247595", "SERVICE_INCIDENT": { "RequesterID": "RequesterID", "ResponseTime": "2022-08-03 01:51:42,2022-08-03 01:51:42", "CurrentState": "OPEN PROVIDER", "ProviderID": "ProviderID", "ProviderPriority": "MEDIUM", "Activity": [ { "ActionLog": "The status of a part line item has changed for task 5327712345-530: Part order number: 5327712345-530-1 Line item: 2 Part number:101920-001 Part description: SPS-POWER SUPPLY,450W,OPAL Status: Shipped", "ParameterList": "ServiceIncidentExt:Create;SISExtensions:Mapped", "NameValuePairList": { "eCPExtMessage_eCPExtControl_Version": "1.0", "eCPExtMessage_eCPExtControl_Name": "SDK Extension", "eCPExtMessage_eCPExtControl_TransactionType": "6", "eCPExtMessage_TRANSACTION_TransactionType": "6", "eCPExtMessage_EXT_SERVICE_INCIDENT_ProviderTaskID": "5327712345-530", "eCPExtMessage_EXT_SERVICE_INCIDENT_ExtendedEvent": "8", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PartOrderNumber": "5327712345-530-1", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_LineItemID": "2", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_PartNumber": "101234-001", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_PartDescription": "SPS-POWER SUPPLY,450W,OPAL", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_ETA": "2022-08-03 19:51:00", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_PartStatus": "Shipped", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_InterveneFlag": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_CarrierID": "UPSN", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_ShipDate": "2022-08-03 14:57:19", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_TrackingNumber": "TrackingNumber", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_SourcedLocation": "SourcedLocation", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_RMANumber": "RMANumber", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_ReturnableCode": "A" } } ] }, "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } }Response
{ "TransactionName": "PROVIDE PROBLEM INFORMATION", "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } } -
POST redfish/v1/message (Reject Resolution)
This transaction is used to notify the Provider that the resolution is not acceptable
Request HeadersThe AgentKey parameter is required for authentication purpose.
ContentType application/json AgentKey A string value specifying the transaction agent key. Request BodyThe Requester has to send an object called Message. The Message contains two fields (RemoteAgentName and TransactionName) and one JSON object (ServiceIncident). The RemoteAgentName parameter is required for routing purpose. These parameters are specific to each CHS and are provided by the GSEM System administrator.
Below table gives what is Mandatory values/objects to be sent while sending the Reject Resolution.
Input Parameters
Required (Yes / No)
RemoteAgentName Yes
TransactionName Yes
SERVICE_INCIDENT Response BodyThe following table indicates the values/objects returned by GSEM Engine.
Output Parameters
TransactionName eCPControl eCPVersion
TransactionStatusCode
TransactionStatus
Additional InfoUpon reception, the GSEM Engine proceeds to the authentication checking and syntax validation of the message (JSON format) and also for validation of the transaction content (mandatory fields, fields format).
After processing the request, the GSEM Engine returns a TransactionStatusCode and a SERVICE_INCIDENT object with State, Comment, Entitled, and Acknowledge values.
The table below provides the possible transaction status code values.
Transaction Status Code
Transaction Status
Description
0
Success
The request has been processed successfully.
1
Duplicate ID
A Service Incident has already been submitted with the same RequesterID for the same Requester.
This status code is only returned when submitting a Service_Request transaction.
2
Invalid context, EventID
The request has been sent with a wrong parameters combination in authentication, JSON syntax, or content validation.
The returned EventID will have to be supplied to report problems to GSEM support.
4
Already processed
The GSEM Engine has already processed this transaction successfully.
Important note: It must never be assumed the transaction has been correctly processed, for receiving an incomplete return, or not receiving a return (for example, in case of a network failure). Therefore, in uncertain contexts, the transaction must be resubmitted until getting a “0” or “4” status.
ExamplesRequest
{ "Message": { "TransactionName": "REJECT RESOLUTION", "RemoteAgentName": "Test_RemoteAgentName", "SERVICE_INCIDENT": { "RequesterID": "TC146959563599", "Comment": "Reason for Rejection", "ACTIVITY": [ { "ActionLog": "Reject Resolution", "LocalDate": "2016-01-11 06:49:42,2016-01-11 12:19:42", "ParameterList": "Service_Incident:Update" } ] }, "eCPControl": { "ECPVersion": "1.0" } } }Response
{ "TransactionName": "REJECT RESOLUTION", "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } } -
POST redfish/v1/message (Provid Admin Info)
A Requester is the organization (Service, Company) that created the initial call. The Requester has to register specific information (contract ID, description of the problem, etc that will be passed to the Provider
Request HeadersAgentKey This Field is specifying the transaction agent key string mandatory Request BodyobjeCPMessage Which is an object for Input string MandatoryeCPControl Which is an Input message head part string OptionalECPVersion Identify the version of the API specification that is used. string MandatoryRemoteAgentName specifying the remote agent name for the transaction. string MandatoryTransactionStatus An expression evaluating to an object of type string MandatoryTransactionStatusCode An expression evaluating to an object of type string MandatoryTransactionType This field is for specifying for the transaction string MandatoryMessageID This field is for specifying the MessageId string OptionalRemoteAgentType An expression evaluating to an object of type string MandatoryMinWaitingTime Polling rate for the current agent. Returned in each GetMessage response Date Time MandatoryExamplesPOST: https://{appl}/redfish/v1/message AgentKey : (A8sYA8swaKACnKACnKA Request Body: {"objeCPMessage": { "eCPControl": { "ECPVersion": "1.0", "RemoteAgentName": "Test_RemoteAgentName", "TransactionStatus": "", "TransactionStatusCode": "0", "MessageID": "1861415", "RemoteAgentType": "2", "ObjectBuilderID": "HP ITSB SIS Engine V1.0", "MinWaitingTime": "null" }, "SERVICE_INCIDENT": { "RequesterID": "331834_011941356", "RequesterSeverity": "4", "ResponseTime": "2013-09-08 01:19:41,2013-09-08 01:19:41", "ProviderID": "", "ProviderPriority": "", "SERVICE_REQUESTER": { "ORGANIZATION": { "OrganizationName": "Huf Huelsbeck Fuerst GmbH", "ADDRESS": { "AddressType": "0", "GeoAddress1": "Address1", "GeoAddress2": "12345", "City": "City", "Region": "12345", "PostalCode": "12345", "Country": "ZW", "LOCATION": [ { "ID": "+31 123456789", "Type": "PRIMARY_VOICE" }, { "ID": "ab-razak.mohd-zain@hp.com", "Type": "EMAIL" } ] } }, "PERSON": { "FirstName": "Eric", "LastName": "Sonneveld", "ADDRESS": { "addressType": "", "geoAddress1": "", "geoAddress2": "", "city": "", "region": "", "postalCode": "", "country": "", "LOCATION": [ { "ID": "+31 123456789", "Type": "PRIMARY_VOICE" }, { "ID": "ab-razak.mohd-zain@hp.com", "Type": "EMAIL" } ] } } }, "AGREEMENT": { "ContractID": "CN=101394379133", "AgreementType": ";SN=12345;LN=PSID-151023;RI=EUD_SC NETW PNB;PN=Not Provided" }, "ACTIVITY": [{ "ActionLog": "Service_Incident Provide Admin Info", "LocalDate": "2013-09-08 01:19:41,2013-09-08 01:19:41", "ParameterList": "Service_Incident:Update" }], "PROBLEM": { "Impact": "", "Likelihood": "", "EXPRESSION": { "Relation": "AND", "STATEMENT": [ { "StatementRole": "0", "StatementText": "0" }, { "StatementRole": "11", "StatementText": "3" } ] } } }, "TRANSACTION": { "TransactionType": "7" } } }Response BodyService Incident contains all Service Incident data. It is structured in compliance with the SIS standard string N/ARequesterID Service incident's ID that is generated by the requester. This is the official Service Incident ID when referred to by either party. string N/ARequesterSeverity Severity of the problem as defined by the Requester the message like Critical, Medium etc string N/AAgreement Type Complementary information. Predetermined information can be passed in this field by using tags such as SN or PN. string N/AAddress Specifying the address details string N/AAction Log What was done to the service incident. Contains a descriptive text of the activity that has been accomplished. It can be a copy of the log entry of the CHS that details the activity. string N/ATransactionType This field is for specifying for the transaction string N/AExamples{ @*"@@Odata.context": "https://{appl}/redfish/v1/$metadata#GSEMCloud.Models.ResposeData",*@"TransactionType": "", "TransactionAgentKey": "", "RemoteAgentName": "", "RemoteAgentType": "", "ID": "", "Acknowledgement": "", "SERVICE_INCIDENT": { "RequesterID": "", "RequesterSeverity": "", "ResponseTime": "", "ProviderID": "", "ProviderPriority": "", "SERVICE_REQUESTER": { "ORGANIZATION": { "OrganizationName": "Huf Huelsbeck Fuerst GmbH", "ADDRESS": { "AddressType": "", "GeoAddress1": "", "GeoAddress2": "", "City": "", "Region": "", "PostalCode": "", "Country": "", "LOCATION": [] } }, "PERSON": { "FirstName": "", "LastName": "", "ADDRESS": { "addressType": "", "geoAddress1": "", "geoAddress2": "", "city": "", "region": "", "postalCode": "", "country": "", "LOCATION": [] } } }, "AGREEMENT": { "ContractID": "", "AgreementType": "" }, "ACTIVITY": [{ "ActionLog": "", "LocalDate": "", "ParameterList": "" }], "PROBLEM": { "Impact": "", "Likelihood": "", "EXPRESSION": { "Relation": "", "STATEMENT": [] } } }, "eCPControl": { "ECPVersion": "1.0", "TransactionStatus": "Ok", "TransactionStatusCode": "200", "ObjectBuilderID": "HP ITSB SIS Engine V1.0", "MinWaitingTime": "" } } -
POST redfish/v1/message (Query Incident)
This transaction is used to obtain the most up-to-date SERVICE_INCIDENT state. It returns the full SERVICE_INCIDENT object from the GSEM Engine. For this transaction, the ACTIVITY object is not appended to the SERVICE_INCIDENT object.
Request HeadersThe AgentKey parameter is required for authentication purpose.
ContentType application/json AgentKey A string value specifying the transaction agent key. Request BodyThe Requester has to send an object called Message. The Message contains two fields (RemoteAgentName and TransactionName) and one JSON object (ServiceIncident). The RemoteAgentName parameter is required for routing purpose. These parameters are specific to each CHS and are provided by the GSEM System administrator.
Below table gives what is Mandatory values/objects to be sent while sending the Query Incident.
Input Parameters
Required (Yes / No)
RemoteAgentName
Yes
TransactionName Yes
SERVICE_INCIDENT Response BodyThe following table indicates the values/objects returned by GSEM Engine.
Output Parameters
TransactionName eCPControl eCPVersion
TransactionStatusCode
TransactionStatus
SERVICE_INCIDENT Additional InfoUpon reception, the GSEM Engine proceeds to the authentication checking and syntax validation of the message (JSON format) and also validation of the transaction content (mandatory fields, fields format).
After processing the request, the GSEM Engine returns a TransactionStatusCode and a SERVICE_INCIDENT object with State, Comment, Entitled, and Acknowledge values.
The table below provides the possible transaction status code values.
Transaction Status Code
Transaction Status
Description
0
Success
The request has been processed successfully.
1
Duplicate ID
A Service Incident has already been submitted with the same RequesterID for the same Requester.
This status code is only returned when submitting a Service_Request transaction.
2
Invalid context, EventID
The request has been sent with a wrong parameters combination in authentication, JSON syntax, or content validation.
The returned EventID will have to be supplied to report problems to GSEM support.
4
Already processed
The GSEM Engine has already processed this transaction successfully.
Important note: It must never be assumed the transaction has been correctly processed, for receiving an incomplete return, or not receiving a return (for example, in case of a network failure). Therefore, in uncertain contexts, the transaction must be resubmitted until getting a “0” or “4” status.
ExamplesRequest
{ "Message": { "TransactionName": "QUERY INCIDENT", "RemoteAgentName": "RemoteAgentName", "SERVICE_INCIDENT": { "RequesterID": "TC1469512345", "ACTIVITY": [{ "ActionLog": "Query Incident", "LocalDate": "2023-01-11 08:49:52,2023-01-11 09:49:52", "ParameterList": "Service_Incident:Read" }] }, "eCPControl": { "ECPVersion": "1.0" } } }Response
{ "TransactionName": "QUERY INCIDENT", "SERVICE_INCIDENT": { "RequesterID": "TC1469512345", "RequesterSeverity": "CRITICAL", "ResponseTime": "2023-01-11 16:33:59,2023-01-11 17:33:59", "SERVICE_REQUESTER": { "PERSON": { "LastName": "Sonneveld", "ADDRESS": { "LOCATION": [ { "ID": "+31 123412345", "Type": "PRIMARY_VOICE" } ] } } }, "AGREEMENT": { "ContractID": "CN=101394312345" }, "ACTIVITY": [ { "ActionLog": "Service_Incident Submission", "LocalDate": "2022-09-08 01:19:41,2022-09-08 01:19:41", "ParameterList": "Service_Incident:Create" }, { "ActionLog": "Service_Incident Submission", "LocalDate": "2022-09-08 01:19:41,2022-09-08 01:19:41", "ParameterList": "Service_Incident:Update" }, { "ActionLog": "Service_Incident Submission", "LocalDate": "2022-09-08 01:19:41,2022-09-08 01:19:41", "ParameterList": "Service_Incident:Update" }, { "ActionLog": "Entitlement", "LocalDate": "2022-01-11 16:09:23,2022-01-11 17:09:23", "ParameterList": "Service_Incident:Update" }, { "ActionLog": "Service_Incident ProblemSubmittal", "LocalDate": "2022-07-04 10:49:17,2022-07-04 10:49:17", "ParameterList": "Service_Incident:Update" }, { "ActionLog": "Accept Problem", "LocalDate": "2022-01-11 16:33:47,2022-01-11 17:33:47", "ParameterList": "Service_Incident:Update" }, { "ActionLog": "Provide Problem Information", "LocalDate": "2022-01-11 06:49:42,2022-01-11 12:19:42", "ParameterList": "Problem:Add" }, { "ActionLog": "Problem Resolution", "LocalDate": "2022-01-11 16:44:47,2022-01-11 17:44:47", "ParameterList": "Solution:Create", "NameValuePairList": { "eCPExtMessage_eCPExtControl_Version": "2.0", "eCPExtMessage_eCPExtControl_Name": "SDK Extension", "eCPExtMessage_eCPExtControl_TransactionType": "4", "eCPExtMessage_ExtServiceIncident_WorkflowStatus": "Partner Accept", "eCPExtMessage_ExtServiceIncident_OrderTypeCode": "05R", "eCPExtMessage_ExtServiceIncident_Knowledge_SourceLink": ";www.source.com", "eCPExtMessage_ExtServiceIncident_Knowledge_DisclosureLevel": "1", "eCPExtMessage_Transaction_TransactionType": "4" } }, { "ActionLog": "Reject Resolution", "LocalDate": "2022-01-11 06:49:42,2022-01-11 12:19:42", "ParameterList": "Service_Incident:Update" } ], "PROBLEM": { "EXPRESSION": { "Relation": "AND", "STATEMENT": [ { "StatementRole": "TITLE", "StatementText": "Servers down" }, { "StatementRole": "DESCRIPTION", "StatementText": "Description of problem" } ] } }, "CurrentState": "OPEN PROVIDER", "Comment": "Entitlement Comment", "Entitled": "YES", "ProviderID": "TP1469612345", "ProviderPriority": "MEDIUM", "SERVICE_PROVIDER": { "PERSON": { "LastName": "Sonneveld", "ADDRESS": { "LOCATION": [ { "ID": "+31 123412345", "Type": "PRIMARY_VOICE" } ] } } } }, "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } } -
POST redfish/v1/message (Confirm Close)
After having received a ProblemResolution transaction, this transaction is used to notify the Provider as the resolution is accepted. This transaction triggers the closure of the call. A Comment can be passed.
Request HeadersThe AgentKey parameter is required for authentication purpose.
ContentType application/json AgentKey A string value specifying the transaction agent key. Request BodyThe Requester has to send an object called Message. The Message contains two fields (RemoteAgentName and TransactionName) and one JSON object (ServiceIncident). The RemoteAgentName parameter is required for routing purpose. These parameters are specific to each CHS and are provided by the GSEM System administrator.
Below table gives what is Mandatory values/objects to be sent while sending the Confirm Close.
Input Parameters
Required (Yes / No)
RemoteAgentName
Yes
TransactionName Yes
SERVICE_INCIDENT Response BodyThe following table indicates the values/objects returned by GSEM Engine.
Output Parameters
TransactionName eCPControl eCPVersion
TransactionStatusCode
TransactionStatus
Additional InfoUpon reception, the GSEM Engine proceeds to the authentication checking and syntax validation of the message (JSON format) and also for validation of the transaction content (mandatory fields, fields format).
After processing the request, the GSEM Engine returns a TransactionStatusCode and a SERVICE_INCIDENT object with State, Comment, Entitled, and Acknowledge values.
The table below provides the possible transaction status code values.
Transaction Status Code
Transaction Status
Description
0
Success
The request has been processed successfully.
1
Duplicate ID
A Service Incident has already been submitted with the same RequesterID for the same Requester.
This status code is only returned when submitting a Service_Request transaction.
2
Invalid context, EventID
The request has been sent with a wrong parameters combination in authentication, JSON syntax, or content validation.
The returned EventID will have to be supplied to report problems to GSEM support.
4
Already processed
The GSEM Engine has already processed this transaction successfully.
Important note: It must never be assumed the transaction has been correctly processed, for receiving an incomplete return, or not receiving a return (for example, in case of a network failure). Therefore, in uncertain contexts, the transaction must be resubmitted until getting a “0” or “4” status.
ExamplesRequest
{ "Message": { "TransactionName": "CONFIRM CLOSE", "RemoteAgentName": "Test_RemoteAgentName", "SERVICE_INCIDENT": { "RequesterID": "TC1469595635", "Comment": "ConfirmClose Comment", "ACTIVITY": [ { "ActionLog": "Confirm Close", "LocalDate": "2016-01-11 06:49:42,2016-01-11 12:19:42", "ParameterList": "Service_Incident:Update" } ] }, "eCPControl": { "ECPVersion": "1.0" } } }Response
{ "TransactionName": "CONFIRM CLOSE", "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } } -
POST redfish/v1/message (Request Closure)
This transaction is used to terminate the call at any time during the call life. For example, it can be used if the Requester found the solution on its own. The Comment field must document the reason of the request.
Request HeadersThe AgentKey parameter is required for authentication purpose.
ContentType application/json AgentKey A string value specifying the transaction agent key. Request BodyThe Requester has to send an object called Message. The Message contains two fields (RemoteAgentName and TransactionName) and one JSON object (ServiceIncident). The RemoteAgentName parameter is required for routing purpose. These parameters are specific to each CHS and are provided by the GSEM System administrator.
Below table gives what is Mandatory values/objects to be sent while sending the Request Closure.
Input Parameters
Required (Yes / No)
RemoteAgentName Yes
TransactionName Yes
SERVICE_INCIDENT Yes
Response BodyThe following table indicates the values/objects returned by GSEM Engine.
Output Parameters
TransactionName eCPControl eCPVersion
TransactionStatusCode
TransactionStatus
Additional InfoUpon reception, the GSEM Engine proceeds to the authentication checking and syntax validation of the message (JSON format) and also for validation of the transaction content (mandatory fields, fields format).
After processing the request, the GSEM Engine returns a TransactionStatusCode and a SERVICE_INCIDENT object with State, Comment, Entitled, and Acknowledge values.
The table below provides the possible transaction status code values.
Transaction Status Code
Transaction Status
Description
0
Success
The request has been processed successfully.
1
Duplicate ID
A Service Incident has already been submitted with the same RequesterID for the same Requester.
This status code is only returned when submitting a Service_Request transaction.
2
Invalid context, EventID
The request has been sent with a wrong parameters combination in authentication, JSON syntax, or content validation.
The returned EventID will have to be supplied to report problems to GSEM support.
4
Already processed
The GSEM Engine has already processed this transaction successfully.
Important note: It must never be assumed the transaction has been correctly processed, for receiving an incomplete return, or not receiving a return (for example, in case of a network failure). Therefore, in uncertain contexts, the transaction must be resubmitted until getting a “0” or “4” status.
ExamplesRequest
{ "Message": { "TransactionName": "REQUEST CLOSURE", "RemoteAgentName": "Test_RemoteAgentName", "SERVICE_INCIDENT": { "RequesterID": "TC1469595635", "Comment": "Closing The Case - Requeste Closure", "ACTIVITY": [ { "ActionLog": "Request Closure", "LocalDate": "2016-01-11 06:49:42,2016-01-11 12:19:42", "ParameterList": "Service_Incident:Update" } ] }, "eCPControl": { "ECPVersion": "1.0" } } }Response
{ "TransactionName": "REQUEST CLOSURE", "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } } -
POST redfish/v1/message (Query Incident)
This transaction is used to obtain the most up-to-date SERVICE_INCIDENT state. It returns the full SERVICE_INCIDENT object. For this transaction, the ACTIVITY object is not appended to the SERVICE_INCIDENT object.
Request HeadersThe AgentKey parameter is required for authentication purpose.
ContentType application/json AgentKey A string value specifying the transaction agent key. Request BodyThe Requester has to send an object called Message. The Message contains two fields (RemoteAgentName and TransactionName) and one JSON object (ServiceIncident). The RemoteAgentName parameter is required for routing purpose. These parameters are specific to each CHS and are provided by the GSEM System administrator.
Below table gives what is Mandatory values/objects to be sent while sending the Query Incident.
Input Parameters
Required (Yes / No)
RemoteAgentName Yes
TransactionName Yes
SERVICE_INCIDENT Response BodyThe following table indicates the values/objects (It returns the full SERVICE_INCIDENT object) returned by GSEM Engine.
Output Parameters
TransactionName eCPControl eCPVersion
TransactionStatusCode
TransactionStatus
SERVICE_INCIDENT Additional InfoUpon reception, the GSEM Engine proceeds to the authentication checking and syntax validation of the message (JSON format) and also validation of the transaction content (mandatory fields, fields format).
After processing the request, the GSEM Engine returns a TransactionStatusCode and a SERVICE_INCIDENT object with State, Comment, Entitled, and Acknowledge values.
The table below provides the possible transaction status code values.
Transaction Status Code
Transaction Status
Description
0
Success
The request has been processed successfully.
1
Duplicate ID
A Service Incident has already been submitted with the same RequesterID for the same Requester.
This status code is only returned when submitting a Service_Request transaction.
2
Invalid context, EventID
The request has been sent with a wrong parameters combination in authentication, JSON syntax, or content validation.
The returned EventID will have to be supplied to report problems to GSEM support.
4
Already processed
The GSEM Engine has already processed this transaction successfully.
Important note: It must never be assumed the transaction has been correctly processed, for receiving an incomplete return, or not receiving a return (for example, in case of a network failure). Therefore, in uncertain contexts, the transaction must be resubmitted until getting a “0” or “4” status.
ExamplesRequest
{ "Message": { "TransactionName": "QUERY INCIDENT", "RemoteAgentName": "RemoteAgentName", "SERVICE_INCIDENT": { "RequesterID": "TC1469512345", "ACTIVITY": [{ "ActionLog": "Query Incident", "LocalDate": "2023-01-11 08:49:52,2023-01-11 09:49:52", "ParameterList": "Service_Incident:Read" }] }, "eCPControl": { "ECPVersion": "1.0" } } }Response
{ "TransactionName": "QUERY INCIDENT", "SERVICE_INCIDENT": { "RequesterID": "TC1469512345", "RequesterSeverity": "CRITICAL", "ResponseTime": "2023-01-11 16:33:59,2023-01-11 17:33:59", "SERVICE_REQUESTER": { "PERSON": { "LastName": "Sonneveld", "ADDRESS": { "LOCATION": [ { "ID": "+31 123412345", "Type": "PRIMARY_VOICE" } ] } } }, "AGREEMENT": { "ContractID": "CN=101394379133" }, "ACTIVITY": [ { "ActionLog": "Service_Incident Submission", "LocalDate": "2022-09-08 01:19:41,2022-09-08 01:19:41", "ParameterList": "Service_Incident:Create" }, { "ActionLog": "Service_Incident Submission", "LocalDate": "2022-09-08 01:19:41,2022-09-08 01:19:41", "ParameterList": "Service_Incident:Update" }, { "ActionLog": "Service_Incident Submission", "LocalDate": "2022-09-08 01:19:41,2022-09-08 01:19:41", "ParameterList": "Service_Incident:Update" }, { "ActionLog": "Entitlement", "LocalDate": "2022-01-11 16:09:23,2022-01-11 17:09:23", "ParameterList": "Service_Incident:Update" }, { "ActionLog": "Service_Incident ProblemSubmittal", "LocalDate": "2022-07-04 10:49:17,2022-07-04 10:49:17", "ParameterList": "Service_Incident:Update" }, { "ActionLog": "Accept Problem", "LocalDate": "2022-01-11 16:33:47,2022-01-11 17:33:47", "ParameterList": "Service_Incident:Update" }, { "ActionLog": "Provide Problem Information", "LocalDate": "2022-01-11 06:49:42,2022-01-11 12:19:42", "ParameterList": "Problem:Add" }, { "ActionLog": "Problem Resolution", "LocalDate": "2022-01-11 16:44:47,2022-01-11 17:44:47", "ParameterList": "Solution:Create", "NameValuePairList": { "eCPExtMessage_eCPExtControl_Version": "2.0", "eCPExtMessage_eCPExtControl_Name": "na", "eCPExtMessage_eCPExtControl_TransactionType": "create", "eCPExtMessage_ExtServiceIncident_WorkflowStatus": "Partner Accept", "eCPExtMessage_ExtServiceIncident_OrderTypeCode": "05R", "eCPExtMessage_ExtServiceIncident_Knowledge_SourceLink": "ksl", "eCPExtMessage_ExtServiceIncident_Knowledge_DisclosureLevel": "kdl", "eCPExtMessage_Transaction_TransactionType": "4" } }, { "ActionLog": "Reject Resolution", "LocalDate": "2022-01-11 06:49:42,2022-01-11 12:19:42", "ParameterList": "Service_Incident:Update" } ], "PROBLEM": { "EXPRESSION": { "Relation": "AND", "STATEMENT": [ { "StatementRole": "TITLE", "StatementText": "Servers down" }, { "StatementRole": "DESCRIPTION", "StatementText": "Description of problem" } ] } }, "CurrentState": "OPEN PROVIDER", "Comment": "Entitlement Comment", "Entitled": "YES", "ProviderID": "TP1469601416", "ProviderPriority": "MEDIUM", "SERVICE_PROVIDER": { "PERSON": { "LastName": "Sonneveld", "ADDRESS": { "LOCATION": [ { "ID": "+31 123412345", "Type": "PRIMARY_VOICE" } ] } } } }, "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } } -
POST redfish/v1/message (Entitlement)
This transaction is used by the Provider to notify the result of its entitlement checking. The Entitlement field must be set to “Yes” or “No”. In case of “No”, the Comment field must contain the reason of the refusal.
Request HeadersThe AgentKey parameter is required for authentication purpose.
ContentType application/json AgentKey A string value specifying the transaction agent key. Request BodyThe Provider has to send an object called Message.The Message contains two fields (RemoteAgentName and TransactionName) and one JSON object (ServiceIncident). The RemoteAgentName parameter is required for routing purpose. These parameters are specific to each CHS and are provided by the GSEM System administrator.
Below table gives what is Mandatory values/objects to be sent while sending the Entitlement.
Input Parameters
Required (Yes / No)
RemoteAgentName
Yes
TransactionName Yes
SERVICE_INCIDENT Response BodyThe following table indicates the values/objects returned by GSEM Engine.
Output Parameters
TransactionName eCPControl eCPVersion
TransactionStatusCode
TransactionStatus
Additional InfoUpon reception, the GSEM Engine proceeds to the authentication checking and syntax validation of the message (JSON format) and also for validation of the transaction content (mandatory fields, fields format).
After processing the request, the GSEM Engine returns a TransactionStatusCode and a SERVICE_INCIDENT object with State, Comment, Entitled, and Acknowledge values.
The table below provides the possible transaction status code values.
Transaction Status Code
Transaction Status
Description
0
Success
The request has been processed successfully.
1
Duplicate ID
A Service Incident has already been submitted with the same RequesterID for the same Requester.
This status code is only returned when submitting a Service_Request transaction.
2
Invalid context, EventID
The request has been sent with a wrong parameters combination in authentication, JSON syntax, or content validation.
The returned EventID will have to be supplied to report problems to GSEM support.
4
Already processed
The GSEM Engine has already processed this transaction successfully.
Important note: It must never be assumed the transaction has been correctly processed, for receiving an incomplete return, or not receiving a return (for example, in case of a network failure). Therefore, in uncertain contexts, the transaction must be resubmitted until getting a “0” or “4” status.
ExamplesRequest
{ "Message": { "TransactionName": "ENTITLEMENT", "RemoteAgentName": "Test_RemoteAgentName", "SERVICE_INCIDENT": { "RequesterID": "TC1469394645", "Entitled": "YES", "Comment": "Entitlement Comment", "ACTIVITY": [ { "ActionLog": "Entitlement", "LocalDate": "2016-01-11 16:09:23,2016-01-11 17:09:23", "ParameterList": "Service_Incident:Update" } ] }, "eCPControl": { "ECPVersion": "1.0" } } }Response
Note: Current GSEM engine implements shortcut for Problem Submittal as part of Entitlement transaction. Hence json response for Entitlement will contain the Problem Submittal response.{ "TransactionName": "PROBLEM SUBMITTAL" "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } } -
POST redfish/v1/message (Accept Problem)
The Accept Problem transaction is to be executed once the Service Incident has been created in the provider CHS. This transaction notifies the Requester that the Service Incident has been accepted and created also returns the Provider call # in the ProviderID field.
Request HeadersThe AgentKey parameter is required for authentication purpose.
ContentType application/json AgentKey A string value specifying the transaction agent key. Request BodyThe Provider has to send an object called Message. The Message contains two fields (RemoteAgentName and TransactionName) and one JSON object (ServiceIncident). The RemoteAgentName parameter is required for routing purpose. These parameters are specific to each CHS and are provided by the GSEM System administrator.
Below table gives what is Mandatory values/objects to be sent while sending the Accept Problem.
Input Parameters
Required (Yes / No)
RemoteAgentName Yes
TransactionName Yes
SERVICE_INCIDENT Response BodyThe following table indicates the values/objects returned by GSEM Engine.
Output Parameters
TransactionName eCPControl eCPVersion
TransactionStatusCode
TransactionStatus
Additional InfoUpon reception, the GSEM Engine proceeds to the authentication checking and syntax validation of the message (JSON format) and also for validation of the transaction content (mandatory fields, fields format).
After processing the request, the GSEM Engine returns a TransactionStatusCode and a SERVICE_INCIDENT object with State, Comment, Entitled, and Acknowledge values.
The table below provides the possible transaction status code values.
Transaction Status Code
Transaction Status
Description
0
Success
The request has been processed successfully.
1
Duplicate ID
A Service Incident has already been submitted with the same RequesterID for the same Requester.
This status code is only returned when submitting a Service_Request transaction.
2
Invalid context, EventID
The request has been sent with a wrong parameters combination in authentication, JSON syntax, or content validation.
The returned EventID will have to be supplied to report problems to GSEM support.
4
Already processed
The GSEM Engine has already processed this transaction successfully.
Important note: It must never be assumed the transaction has been correctly processed, for receiving an incomplete return, or not receiving a return (for example, in case of a network failure). Therefore, in uncertain contexts, the transaction must be resubmitted until getting a “0” or “4” status.
ExamplesRequest
{ "Message": { "TransactionName": "ACCEPT PROBLEM", "RemoteAgentName": "Test_RemoteAgentName", "SERVICE_INCIDENT": { "RequesterID": "TC1469595635", "ProviderID": "5303508521", "RequesterSeverity": "CRITICAL", "ProviderPriority": "MEDIUM", "ResponseTime": "2016-01-11 16:33:59,2016-01-11 17:33:59", "Comment": "GSEM Cloud - Accept Problem Comment", "SERVICE_PROVIDER": { "PERSON": { "LastName": "Sonneveld", "ADDRESS": { "LOCATION": [ { "ID": "+31 123456789", "Type": "PRIMARY_VOICE" } ] } } }, "ACTIVITY": [ { "ActionLog": "Accept Problem", "LocalDate": "2016-01-11 16:33:47,2016-01-11 17:33:47", "ParameterList": "Service_Incident:Update" } ] }, "eCPControl": { "ECPVersion": "1.0" } } }Response
{ "TransactionName": "ACCEPT PROBLEM" "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } } -
POST redfish/v1/message (Provide Problem Information)
This transaction is used:
•To provide additional information on the problem.
•To add an ACTIVITY instance to record a significant activity.
•To update the RequesterSeverity and the SERVICE_REQUESTER objects.
If SERVICE_REQUESTER is modified, the entire object have to be submitted. The GSEM Engine replaces objects as a whole. The following table identifies mandatory and optional data to be passed for each Provide Problem Information.Request HeadersThe AgentKey parameter is required for authentication purpose.
ContentType application/json AgentKey A string value specifying the transaction agent key. Request BodyThe Provider has to send an object called Message. The Message contains two fields (RemoteAgentName and TransactionName) and one JSON object (ServiceIncident). The RemoteAgentName parameter is required for routing purpose. These parameters are specific to each CHS and are provided by the GSEM System administrator.
Below table gives what is Mandatory values/objects to be sent while sending the Provide Problem Information.
Input Parameters
Required (Yes / No)
RemoteAgentName Yes
TransactionName Yes
SERVICE_INCIDENT StopOnConversion Flag to indicate whether to submit the transaction or not when the NameValuePair list mapping to eCPExtMessage generates a warning. The default value is false. Response BodyThe following table indicates the values/objects returned by GSEM Engine.
Output Parameters
TransactionName eCPControl eCPVersion
TransactionStatusCode
TransactionStatus
Additional InfoUpon reception, the GSEM Engine proceeds to the authentication checking and syntax validation of the message (JSON format) and also for validation of the transaction content (mandatory fields, fields format).
After processing the request, the GSEM Engine returns a TransactionStatusCode and a SERVICE_INCIDENT object with State, Comment, Entitled, and Acknowledge values.
The table below provides the possible transaction status code values.
Transaction Status Code
Transaction Status
Description
0
Success
The request has been processed successfully.
1
Duplicate ID
A Service Incident has already been submitted with the same RequesterID for the same Requester.
This status code is only returned when submitting a Service_Request transaction.
2
Invalid context, EventID
The request has been sent with a wrong parameters combination in authentication, JSON syntax, or content validation.
The returned EventID will have to be supplied to report problems to GSEM support.
4
Already processed
The GSEM Engine has already processed this transaction successfully.
Important note: It must never be assumed the transaction has been correctly processed, for receiving an incomplete return, or not receiving a return (for example, in case of a network failure). Therefore, in uncertain contexts, the transaction must be resubmitted until getting a “0” or “4” status.
ExamplesExample1Example2Example3Request (Example1)
{ "Acknowledge": "false", "TransactionName": "PROVIDE PROBLEM INFORMATION", "TransactionAgentKey": "TransactionAgentKey", "RemoteAgentName": "RemoteAgentName", "RemoteAgentType": "HPE", "MessageID": "3247595", "SERVICE_INCIDENT": { "RequesterID": "RequesterID", "ResponseTime": "2022-08-03 01:51:42,2022-08-03 01:51:42", "CurrentState": "OPEN PROVIDER", "ProviderID": "ProviderID", "ProviderPriority": "MEDIUM", "Activity": [ { "ActionLog": "The status of a part line item has changed for task 5327712345-530: Part order number: 5327784831-530-1 Line item: 2 Part number:101920-001 Part description: SPS-POWER SUPPLY,450W,OPAL Status: Shipped", "ParameterList": "ServiceIncidentExt:Create;SISExtensions:Mapped", "NameValuePairList": { "eCPExtMessage_eCPExtControl_Version": "1.0", "eCPExtMessage_eCPExtControl_Name": "SDK Extension", "eCPExtMessage_eCPExtControl_TransactionType": "6", "eCPExtMessage_TRANSACTION_TransactionType": "6", "eCPExtMessage_EXT_SERVICE_INCIDENT_ProviderTaskID": "5327712345-530", "eCPExtMessage_EXT_SERVICE_INCIDENT_ExtendedEvent": "8", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PartOrderNumber": "5327712345-530-1", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_LineItemID": "2", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_PartNumber": "101920-001", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_PartDescription": "SPS-POWER SUPPLY,450W,OPAL", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_ETA": "2022-08-03 19:51:00", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_PartStatus": "Shipped", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_InterveneFlag": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_CarrierID": "UPSN", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_ShipDate": "2022-08-03 14:57:19", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_TrackingNumber": "TrackingNumber", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_SourcedLocation": "SourcedLocation", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_RMANumber": "RMANumber", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_ReturnableCode": "A" } } ] }, "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } }Request (Example2 - SIS 2.0 Workflow Status Modification)
{ "Acknowledge": "false", "TransactionName": "PROVIDE PROBLEM INFORMATION", "TransactionAgentKey": "TransactionAgentKey", "RemoteAgentName": "RemoteAgentName", "RemoteAgentType": "HPE", "MessageID": "3247567", "SERVICE_INCIDENT": { "RequesterID": "RequesterID", "ResponseTime": "2022-08-03 01:51:42,2022-08-03 01:51:42", "CurrentState": "OPEN PROVIDER", "ProviderID": "ProviderID", "ProviderPriority": "MEDIUM", "Activity": [ { "ActionLog": "The status of a part line item has changed for task 5327712345-530: Part order number: 5327712345-530-1 Line item: 1 Part number:104123-001 Part description: SPS-DRV,HD,36GB,WU,SCA Status: Cancelled", "ParameterList": "ServiceIncidentExt:Create;SISExtensions:Mapped", "NameValuePairList": { "eCPExtMessage_eCPExtControl_Version": "1.0", "eCPExtMessage_eCPExtControl_Name": "SDK Extension", "eCPExtMessage_eCPExtControl_TransactionType": "6", "eCPExtMessage_TRANSACTION_TransactionType": "6", "eCPExtMessage_EXT_SERVICE_INCIDENT_ProviderTaskID": "53277812345-530", "eCPExtMessage_EXT_SERVICE_INCIDENT_ExtendedEvent": "8", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PartOrderNumber": "5327712345-530-1", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_LineItemID": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_PartNumber": "104123-001", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_PartDescription": "SPS-DRV,HD,36GB,WU,SCA", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_ETA": "2022-08-05 14:17:42", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_PartStatus": "Cancelled", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_InterveneFlag": "1" } } ] }, "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } }Request (Example3 - SIS 2.0 Workflow Status Modification)
{ "Acknowledge": "false", "TransactionName": "PROVIDE PROBLEM INFORMATION", "TransactionAgentKey": "TransactionAgentKey", "RemoteAgentName": "RemoteAgentName", "RemoteAgentType": "HPE", "MessageID": "3247569", "SERVICE_INCIDENT": { "RequesterID": "RequesterID", "ResponseTime": "2022-08-03 01:51:42,2022-08-03 01:51:42", "CurrentState": "OPEN PROVIDER", "ProviderID": "ProviderID", "ProviderPriority": "MEDIUM", "Activity": [ { "ActionLog": "A part line item has been added to a part order for task 5327784831-530: Part order number: 5327784831-530-1 Line item: 2 Part number:101920-001 Part description: SPS-POWER SUPPLY,450W,OPAL", "ParameterList": "ServiceIncidentExt:Create;SISExtensions:Mapped", "NameValuePairList": { "eCPExtMessage_eCPExtControl_Version": "1.0", "eCPExtMessage_eCPExtControl_Name": "SDK Extension", "eCPExtMessage_eCPExtControl_TransactionType": "6", "eCPExtMessage_TRANSACTION_TransactionType": "6", "eCPExtMessage_EXT_SERVICE_INCIDENT_ProviderTaskID": "5327712345-530", "eCPExtMessage_EXT_SERVICE_INCIDENT_ExtendedEvent": "10", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PartOrderNumber": "5327712345-530-1", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_LineItemID": "2", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_PartNumber": "101920-001", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_PartDescription": "SPS-POWER SUPPLY,450W,OPAL", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_ETA": "2022-08-03 19:51:00", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_PartStatus": "Recommended", "eCPExtMessage_EXT_SERVICE_INCIDENT_PARTORDER_PARTORDERLINEITEM_InterveneFlag": "0" } } ] }, "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } }Response
{ "TransactionName": "PROVIDE PROBLEM INFORMATION", "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } -
POST redfish/v1/message (Problem Resolution)
The Problem Resolution transaction transmits the problem resolution to the Requester. The resolution details are contained in the Solution object. Here, at least Title and Abstract must be filled.
Request HeadersThe AgentKey parameter is required for authentication purpose.
ContentType application/json AgentKey A string value specifying the transaction agent key. Request BodyThe Provider has to send an object called Message. The Message contains two fields (RemoteAgentName and TransactionName) and one JSON object (ServiceIncident). The RemoteAgentName parameter is required for routing purpose. These parameters are specific to each CHS and are provided by the GSEM System administrator.
Below table gives what is Mandatory values/objects to be sent while sending the Problem Resolution.
Input Parameters
Required (Yes / No)
RemoteAgentName Yes
TransactionName Yes
SERVICE_INCIDENT StopOnConversion Flag to indicate whether to submit the transaction or not when the NameValuePair list mapping to eCPExtMessage generates a warning. The default value is false. Response BodyThe following table indicates the values/objects returned by GSEM Engine.
Output Parameters
TransactionName eCPControl eCPVersion
TransactionStatusCode
TransactionStatus
Additional InfoUpon reception, the GSEM Engine proceeds to the authentication checking and syntax validation of the message (JSON format) and also for validation of the transaction content (mandatory fields, fields format).
After processing the request, the GSEM Engine returns a TransactionStatusCode and a SERVICE_INCIDENT object with State, Comment, Entitled, and Acknowledge values.
The table below provides the possible transaction status code values.
Transaction Status Code
Transaction Status
Description
0
Success
The request has been processed successfully.
1
Duplicate ID
A Service Incident has already been submitted with the same RequesterID for the same Requester.
This status code is only returned when submitting a Service_Request transaction.
2
Invalid context, EventID
The request has been sent with a wrong parameters combination in authentication, JSON syntax, or content validation.
The returned EventID will have to be supplied to report problems to GSEM support.
4
Already processed
The GSEM Engine has already processed this transaction successfully.
Important note: It must never be assumed the transaction has been correctly processed, for receiving an incomplete return, or not receiving a return (for example, in case of a network failure). Therefore, in uncertain contexts, the transaction must be resubmitted until getting a “0” or “4” status.
ExamplesExample1Example2Example3Request (Example1)
{ { "Acknowledge": "false", "TransactionName": "PROBLEM RESOLUTION", "TransactionAgentKey": "TransactionAgentKey", "RemoteAgentName": "RemoteAgentName", "RemoteAgentType": "HPE", "MessageID": "3247603", "SERVICE_INCIDENT": { "RequesterID": "RequesterID", "CurrentState": "CLOSED PENDING CONFIRMATION", "ProviderID": "ProviderID", "SOLUTION": { "REFERENCE": { "EXPRESSION": { "STATEMENT": [ { "StatementRole": "DESCRIPTION", "StatementText": "[Part Shipped][CSR][Part Shipped]" }, { "StatementRole": "TITLE", "StatementText": "Part Shipped" } ] } } }, "Activity": [ { "ActionLog": "Problem Resolution", "LocalDate": "2022-08-03 15:15:28,2022-08-03 15:15:28", "ParameterList": "ServiceIncidentExt:Create;SISExtensions:Mapped:Solution:Create", "NameValuePairList": { "eCPExtMessage_eCPExtControl_Version": "1.0", "eCPExtMessage_eCPExtControl_Name": "SDK Extension", "eCPExtMessage_eCPExtControl_TransactionType": "4" } } ] }, "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } } }Request (Example2)
{ "Acknowledge": "false", "TransactionName": "PROBLEM RESOLUTION", "TransactionAgentKey": "TransactionAgentKey", "RemoteAgentName": "RemoteAgentName", "RemoteAgentType": "HPE", "MessageID": "3247725", "SERVICE_INCIDENT": { "RequesterID": "RequesterID", "CurrentState": "CLOSED PENDING CONFIRMATION", "ProviderID": "ProviderID", "SOLUTION": { "REFERENCE": { "EXPRESSION": { "STATEMENT": [ { "StatementRole": "DESCRIPTION", "StatementText": "[Onsite Repair][Onsite Repair][Onsite][Replaced parts, issue resolved]Replaced parts, issue resolved" }, { "StatementRole": "TITLE", "StatementText": "Onsite Repair" } ] } } }, "Activity": [ { "ActionLog": "Problem Resolution", "LocalDate": "2022-08-03 17:22:09,2022-08-03 17:22:09", "ParameterList": "ServiceIncidentExt:Create;SISExtensions:Mapped:Solution:Create", "NameValuePairList": { "eCPExtMessage_eCPExtControl_Version": "1.0", "eCPExtMessage_eCPExtControl_Name": "SDK Extension", "eCPExtMessage_eCPExtControl_TransactionType": "4", "eCPExtMessage_ExtServiceIncident_Repair_RepairClass": "CO", "eCPExtMessage_ExtServiceIncident_Repair_RepairClassText": "Rpr,Compt,Parts Repl", "eCPExtMessage_ExtServiceIncident_Repair_DelayCode": "8", "eCPExtMessage_ExtServiceIncident_Repair_DelayCodeText": "Customer caused Delay", "eCPExtMessage_ExtServiceIncident_Repair_ServiceStartDateTime": "2022-08-03 16:49:55", "eCPExtMessage_ExtServiceIncident_Repair_SystemFixedTime": "2022-08-03 17:19:46", "eCPExtMessage_ExtServiceIncident_Repair_ServiceEndDateTime": "2022-08-03 17:19:46", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_InstalledPartNumber": "101234-001", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_InstalledSerialNumber": "FDHFISHDFI", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_InstalledPartDescription": "SPS-POWER SUPPLY,450W,OPAL", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_RemovedPartNumber": "101234-001", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_RemovedSerialNumber": "GRJGFKGNG", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART_RemovedPartDescription": "SPS-POWER SUPPLY,450W,OPAL", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_InstalledPartNumber": "101234-001", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_InstalledSerialNumber": "IJHRJFGGD", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_InstalledPartDescription": "SPS-POWER SUPPLY,450W,OPAL", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_RemovedPartNumber": "101920-001", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_RemovedSerialNumber": "GRGEGREG", "eCPExtMessage_ExtServiceIncident_Repair_REPAIRPART1_RemovedPartDescription": "SPS-POWER SUPPLY,450W,OPAL", "eCPExtMessage_ExtServiceIncident_Repair_RepairDuration": "00:30", "eCPExtMessage_ExtServiceIncident_Repair_TravelDuration": "00:27" } } ] }, "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } }Request (Example3)
{ "Acknowledge": "false", "TransactionName": "PROBLEM RESOLUTION", "TransactionAgentKey": "TransactionAgentKey", "RemoteAgentName": "RemoteAgentName", "RemoteAgentType": "HPE", "MessageID": "3247608", "SERVICE_INCIDENT": { "RequesterID": "RequesterID", "CurrentState": "CLOSED PENDING CONFIRMATION", "ProviderID": "ProviderID", "SOLUTION": { "REFERENCE": { "EXPRESSION": { "STATEMENT": [ { "StatementRole": "DESCRIPTION", "StatementText": "[Resolved][Firmware/BIOS/ Driver updates/CSU][Remote Resolve][Customer upgraded the Smart Array Controller firmware. Issue resolved.]" }, { "StatementRole": "TITLE", "StatementText": "Resolved" } ] } } }, "Activity": [ { "ActionLog": "Problem Resolution", "LocalDate": "2022-08-03 15:16:17,2022-08-03 15:16:17", "ParameterList": "ServiceIncidentExt:Create;SISExtensions:Mapped:Solution:Create", "NameValuePairList": { "eCPExtMessage_eCPExtControl_Version": "1.0", "eCPExtMessage_eCPExtControl_Name": "SDK Extension", "eCPExtMessage_eCPExtControl_TransactionType": "4" } } ] }, "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } }Response
{ "TransactionName": "PROBLEM RESOLUTION", "eCPControl": { "ECPVersion": "1.0", "TransactionStatusCode": "0", "TransactionStatus": "Success", "ObjectBuilderID": "HPE GSEMCLOUD R1" } } -
Push Message
This reqeust is made from GSEM Push Service to the CHS Web service.
Request HeadersAuthorization 64 bit encoded (username and password) contentType application/json Request BodyThe following table indicates the values/objects that will be sent to CHS WS as a request message
Output Parameters
TransactionName eCPControl acknowledge SERVICE_INCIDENT Response HTTP StatusThe following is the list of error codes understood by the Push ServiceHTTP status codes
Summary
200 OK Client processed the request and return the status to caller If there is no pending transaction, the request returns only TransactionStatusCode parameters with the appropriate value (See table below).
If the request has found a pending transaction, it returns a “0” transaction status code, the MessageID, the RemoteAgentName, the RemoteAgentType, the SERVICE_INCIDENT object (which contains the transaction data), and the TRANSACTION object (which contains the transaction ID).
The MessageID value will have to be reused in the corresponding AcknowledgeMessage request.
The table below provides the possible transaction status code values.
Transaction Status Code
Transaction Status
Description
0
Success
The request has successfully processed by CHS
1
Error
The request has successfully processed by CHS
ExamplesRequest
https://{appl}/redfish/v1/MessageResponse
{ { "Acknowledge": "false", "TransactionName": "SERVICE REQUEST", "TransactionAgentKey": "TransactionAgentKey", "RemoteAgentName": "RemoteAgentName", "RemoteAgentType": "RemoteAgentType", "MessageID": "376591234", "SERVICE_INCIDENT": { "RequesterID": "5372536543-532", "RequesterSeverity": "MAJOR", "CurrentState": "NOT ENTITLED", "SERVICE_REQUESTER": { "ORGANIZATION": { "OrganizationName": "OrganizationName", "ADDRESS": { "AddressType": "PRIMARY", "GeoAddress1": "XYZ", "GeoAddress2": "", "City": "XYZ", "Region": "AV", "PostalCode": "123456", "TimeZone": "XYZ", "Country": "US" } }, "PERSON": { "FirstName": "XYZ", "LastName": "ABC", "ContactType": "LG=English", "ADDRESS": { "LOCATION": [ { "ID": "1-248-1234567", "Type": "PRIMARY_VOICE" }, { "ID": "124812345678", "Type": "ALTERNATE_VOICE" }, { "Type": "FAX" }, { "ID": "xyz.abc@xyz.com", "Type": "EMAIL" } ] } } }, "AGREEMENT": { "ContractID": "104961440344", "AgreementType": "LN=;DT=2023-04-03 23:27:42;PN=H6Z14B;SN=2MT850A5K5;RI=USA-PR-SOUTHEAST;LG=English" }, "Activity": [ { "ActionLog": "Service_Incident Submission", "LocalDate": "2023-04-04 03:40:24,2023-04-04 03:40:24", "ParameterList": "Service_Incident:Create", "NameValuePairList": { "eCPExtMessage_eCPExtControl_Version": "1.0", "eCPExtMessage_eCPExtControl_Name": "SDK Extension", "eCPExtMessage_EXT_SERVICE_INCIDENT_MaintenanceWindowFlag": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_OrderTypeCode": "05R", "eCPExtMessage_EXT_SERVICE_INCIDENT_AssetLocationDetails": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_FirstName": "Jean", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_LastName": "Benoit", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_ADDRESS_LOCATION_Type": "PRIMARY_VOICE", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_ADDRESS_LOCATION_ID": "+1-571-123-1234", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_ADDRESS_LOCATION1_Type": "EMAIL", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICE_REQUESTERALTERNATE_PERSON_ADDRESS_LOCATION1_ID": "xyz.abc@xyz.com", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_SpecialAccessOnsiteResources": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_LatestServiceDeliveryTime": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_GuaranteedFixTime": "2023-04-03 19:16:00", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EntitlementSummary": "Tech Care Critical - (HPE Tech Care Critical wDMR SVC) - HPE Hardware Tech Support 6HR Repair / 24X7; Defective Media Retention| Outage Management | Ship To : US | CON End Date : 2024-03-31", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_Coverage": "24x7", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EntitlementSLAResponse": "REPAIR_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_CoverageResponse": "6HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EstimatedDeliveryDays": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EstimatedDeliveryHours": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EstimatedDeliveryMinutes": "57", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_AdvisoryNumber": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_AdvisoryURL": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_RequestedServiceWindowStartTime": "2023-04-04 13:00:00", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_Description": "HPE Hardware Tech Support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_PackageDescription": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_Description": "GIS_TCHW_PARTS", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_Value": "Y", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_EntitlementType": "C", "eCPExtMessage_EXT_SERVICE_INCIDENT_CaseOrigin": "CEP", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICEDELIVERY_TaskType": "Repair", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL1Name": "Storage", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL2Name": "Disk Storage Systems", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL3Name": "3PAR StoreServ Storage", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL4Name": "3PAR StoreServ Storage", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL5Name": "HPE 3PAR StoreServ 8000 Storage", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL6Name": "HPE 3PAR StoreServ 8000 Storage", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL1OID": "12169", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL2OID": "304617", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL3OID": "5347711", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL4OID": "5346921", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL5OID": "8737813", "eCPExtMessage_EXT_SERVICE_INCIDENT_PMasterL6OID": "1008632545", "eCPExtMessage_EXT_SERVICE_INCIDENT_PSAProjectID": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_DispatchedDateTime": "2023-04-04 03:40:18", "eCPExtMessage_EXT_SERVICE_INCIDENT_Location_ResidentLocation": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_Location_Resident24X7": "0", "eCPExtMessage_EXT_SERVICE_INCIDENT_PL": "4A", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICEDELIVERY_SKILLSET_SkillName": "3PAR StoreServ Storage_5347711_P", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICEDELIVERY_SKILLSET_SkillLevel": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICEDELIVERY_SKILLSET1_SkillName": "Break-Fix and Repair", "eCPExtMessage_EXT_SERVICE_INCIDENT_SERVICEDELIVERY_SKILLSET1_SkillLevel": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER": "CONTRACT_TYPE", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER_Description": "Tech Care", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER_Value1": "TC", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER1": "GIS_TCHW_MATERIAL_HANDLING", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER1_Description": "Defective Media Retention", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER1_Value1": "DEF", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER1_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER2": "DELIVERY_METHOD", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER2_Description": "Onsite support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER2_Value1": "ONS", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER2_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER3": "GIS_TCHW_TRAVEL_ZONE", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER3_Description": "Travel Zone 1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER3_Value1": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER3_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER4": "COV_WINDOW7", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER4_Description": "24hrs, 7 days coverage", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER4_Value1": "24", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER4_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER5": "GIS_TCHW_SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER5_Description": "Service Level Key", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER5_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER5_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER6": "REPAIR_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER6_Description": "6hr Call to Repair", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER6_Value1": "6HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER6_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER7": "RESPONSE_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER7_Description": "4hr onsite response", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER7_Value1": "4HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER7_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER8": "SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER8_Description": "Critical Support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER8_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER8_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER9": "CONTRACT_TYPE", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER9_Description": "Tech Care", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER9_Value1": "TC", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER9_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER10": "GIS_TCHW_MATERIAL_HANDLING", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER10_Description": "Defective Media Retention", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER10_Value1": "DEF", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER10_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER11": "DELIVERY_METHOD", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER11_Description": "Onsite support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER11_Value1": "ONS", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER11_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER12": "GIS_TCHW_TRAVEL_ZONE", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER12_Description": "Travel Zone 1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER12_Value1": "1", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER12_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER13": "COV_WINDOW7", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER13_Description": "24hrs, 7 days coverage", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER13_Value1": "24", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER13_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER14": "GIS_TCHW_SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER14_Description": "Service Level Key", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER14_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER14_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER15": "REPAIR_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER15_Description": "6hr Call to Repair", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER15_Value1": "6HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER15_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER16": "RESPONSE_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER16_Description": "4hr onsite response", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER16_Value1": "4HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER16_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER17": "SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER17_Description": "Critical Support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER17_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER17_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER18": "COV_WINDOW7", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER18_Description": "24hrs, 7 days coverage", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER18_Value1": "24", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER18_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER19": "GIS_TCHW_SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER19_Description": "Service Level Key", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER19_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER19_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER20": "REPAIR_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER20_Description": "6hr Call to Repair", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER20_Value1": "6HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER20_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER21": "RESPONSE_TIME", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER21_Description": "4hr onsite response", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER21_Value1": "4HR", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER21_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER22": "SERVICE_LEVEL", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER22_Description": "Critical Support", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER22_Value1": "CRIT", "eCPExtMessage_EXT_SERVICE_INCIDENT_OBLIGATION_OFFER_DELIVERABLE_MODIFIER22_Value2": "", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/Td0ay6TN5hCZYRpyETnby2hQJwG3%2Fiwz5mp7YHT%2FNpg=/DMV9vh%2F%2F2ThRGcx9uwggnbK9KYfy4YKrPLyDtj41TfY=/Q3kWvxrCEVjbiZbnpmYcH9yWIyt1%2FbDA1Wx7RYHgYNs=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT1_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/e+R5zZBeiPo+f3i+ZLt5KWZ7Y02eACaakcMFkziiAmE=/3lpGGYm3H%2FBqu3r5R4XNppV1%2FgdGMayScGlrXQOne2c=/PXEGweWzdvMOIg%2FBUs3cPAFEObeimdDNbBWWOiIy%2Feg=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT2_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/7oHK%2FZwNuDloZ5XZJut5xplcGNmn8AnBWqN%2FQ4ywkNw=/7E2zsz7n9ybVV7EX4heRTIGmyU2sruKgGWh0bwGD76c=/K6l01SFKUdysVOtTZo%2FNEAHXTn9FRO%2FJUlM3rATHjnY=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT3_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/UF7GT8IEe1zjSl%2FamsZVeVIfPhVfHN6PGw4rRFP6DHA=/8G7n0Ex5+Vgo7uOUOva%2Ft5imegfqKFbxdsscCM9j5TQ=/28DMuUkhhKaT7vOuiaKuNkCdv4gr%2F9jDkhxiRrYdWMU=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT4_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/NgYgyCumS08HjGItyVCujprCvElmnSzWDo4jwY6EDpM=/aWPXHJUcRB7YIQMcHd3M69PNpCZF%2FHDhc3+lKucPYJo=/g+pni9jLL%2FWQ2BYKKmadRevsu7ztDeSN25MHCZtm%2FjY=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT5_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/KLFhcZQHlrtSGVF5+pZhj5VneK+jRhZ3H0u7bE5Zuhk=/gjFMO8MsKFisrZ0aGqXuhWcgUb1Uj9QMpCbxC3ymZuM=/wNhPz%2F4UQm%2FE75OeHbT6u3GvL0DLwsnxV7c+4xGnIdg=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT6_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/Lj8iTizlRbzb9GA3hlC8vcv%2FuD7Jxo4qEn2fYVqnMbc=/%2Fl+VGg0Ff7YxTukPreSnl60LLIRatA8lvRoy1K1CSzI=/VUimyDoLMClKk1AIWSkefK+mp6hxT5vLc34OHsGiEDE=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT7_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/z13audbpnOqzEH6n8R8b+Aet7Ep7A7ubDIAVwDHlxkg=/OlB+0gEnfDsFrsI2vOfi1Snv20CTV%2Fu1kXJ6qEI73vU=/vR6JsTjm+shllAUijqtJ0M7cNJsWNVM1xHTuZ7LIwfY=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT8_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/uJWKuUHjbzObunVwRDWh8%2FM1Ecy1tljgU2M0VpKBRLc=/EkhBprBHun2JtXtsyjA8wReg9zqoUXedSTcpwWudTIQ=/++dDqkzoFqu95yrRTclzfZVICakc7klost94U8FF2Cg=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT9_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/xhJpSOosLFsY%2FvVSQfLNwfbg4j%2FwIdvjYZMPK9NXVCo=/MahWLOXTjAqVJf8Gl6D5dIHwZPng01sPGFkPPvMgjtk=/%2F3tqdms0FDds4VWKP0BZPAV9D+5EBvu0lCG%2FlXbMQw0=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT10_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/M2Y3AxYZiAtVQNRg3+tN7rYFuuLRDRmzjG9w%2FoTOlzc=/J6XByH%2FGG4kuyty0AUDx2QL4mUHQJr+gigJXwziD+TM=/q+FgTrnN0cscAzRXjh%2FqxriY2ZT%2FPRe5rSlnhTLBTAI=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT11_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/lXENd1fAgxsdEQCl7ZpVMs43zyVVjo3pVyVH7kh9aSE=/T8Hh6IdAyk4+3hYi1BOT7L78TyDNn6nfPaZq4gh0MaY=/GHy9ZckQ1Sfsfpcv6QCSGdRTw3qsSk3xMB%2Fk6DHYcJg=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT12_URL": "https://file-upload-download.itcs.hpe.com/download/attachment/tqcmAhU+iBon85gCX39ERxPKN4gLH8XinjEa4SKc2Ac=/INeLEuesmEq30Z9IngKogcR0vQODysGzOfNB609mPZ0=/sth%2FnLg4GNoD7McQunaDGjvWugA+fOpF6saMtSUZEZw=", "eCPExtMessage_EXT_SERVICE_INCIDENT_ATTACHMENT13_URL": "https://file-upload-download.itcs.hpe.com/download/chatter/ZwURqB1Dwc+eCymUrY+WOXGMYAm3GRTaAFCgNZl5QNg=/%2FY8ezeHw6xfZVbw+7F17Vq643bFw8OU540M0LqIjv0U=/vQ7DTUQRJ6iVk3POpryS0VcoG%2FVSvp%2FAJDSbRD+kmtc=" } } ] } } -
Skills API
This functionality is an Addison based API that can give the caller all available GSD Skill Categories and contained Skills
Request Headersclientname [Client name eg:GetSkillsClient] Authorization Basic [user name and password Encrypted] Content-Type application/json Method Get Response Body{ "errorCode": 0, "errorMessage": "", "result": [ { "Category_Name": "Language", "Skill_Name": "Strine", "Modified_Date": "2017-07-22T13:57:08.503Z", "IsActive": true }, { "Category_Name": "Language", "Skill_Name": "Tamil", "Modified_Date": "2017-07-22T13:57:08.503Z", "IsActive": true }, . . . . . ] }Response HTTP StatusThe following is the list of error codes understood by the Push Service
HTTP Status Codes Summary 200 OK Client processed the request and return the status to caller Error MessageDescription Error Code Error Message Success 0 Error Non zero [Error message] -
Attachment Upload Functionality
This functionality will enable partner to upload a file to a case / task
Request HeadersKey Value Description Content-Type multipart/form-data; Method Post objectname Case ex: case or cksw__task__C objectid [Case/Task Number] eg:5310510595 or 531051059-532 Request Bodyform-data [Select File that need to be upload] File that has to be uploaded into the case / task Response Body{"statusCode": 200,"message": {"Msg": "File uploaded successfully"}}Response HTTP StatusThe following is the list of error codes understood by the Push Service
HTTP Status Codes Summary 200 OK Client processed the request and return the status to caller Error MessageDescription Error Code Error Message Success 200 Error anything other than 200 [Error message] -
Attachment Download Functionality
Download attachment from SFDC on case or task
Request HeadersKey value Description Content-Type application/json Method Get Response BodyFile will get downloaded.Response HTTP StatusThe following is the list of error codes understood by the Push Service
HTTP Status Codes Summary 200 OK Client processed the request and return the status to caller Error MessageDescription Error Code Error Message Success 0 Error Non zero [Error message] -
Outage/BCP API
This API is used to retrieve the last 60 minutes of Task detail from HPE systems that are assigned to a given partner during GSEM/Partner system downtime.
Request HeadersMethod Get Content-Type application/json Syntax : [URL]/getPartnerTaskList/[Provider Agent Name] Example : [URL]/getPartnerTaskList/TestPartner_Prod_PResponse Body[ { "BCPTaskId":"1900010657-191", "Task_Id__c":"5324702956-531", "SFDCId":null, "BCPCaseNumber":"1900010657", "SFDCCaseNumber":"5324702956", "Assigned_Partner__c":"aIh27000000GmdXCAS", "Record_Name__c":null, "Subject":"Test Subject", "Problem_Description__c":"test", "Issue__c":"This is the issue", "GSD_Environment__c":"This is Test env", "CKSW__VisitPlan__c":null, "Customer_Reference_Id__c":null, "CreatedDate":null, "Case_Severity__c":null, "Customer_Requested_Start_Day__c":"21", "Customer_Requested_Start_Month__c":"05", "Customer_Requested_Start_Time__c":"03:38:00", "Customer_Requested_Start_Year__c":"2018", "Customer_Requested_End_Day__c":"21", "Customer_Requested_End_Month__c":"05", "Customer_Requested_End_Time__c":"09:38:00", "Customer_Requested_End_Year__c":"2018", "Product_Number__c":"286778-B22", "Product_Description__c":"72GB 15K U320 UNI HDD ALL", "Serial_Number__c":"SGJ743G0U6", "CKSW__AccountName__c":"The Coca-Cola Company", "Contact_First_Name__c":"Test GDPR", "Contact_Last_Name__c":"DoNotCall", "Requestor_Language__c":"English", "Contact_Phone_Number__c":"(281) 979-1138", "Address_Line2__c":null, "Address_Line3__c":null, "CKSW__City__c":"ALPHARETTA", "CKSW__State__c":"GA", "Location__c":"a5P27000001NhXcEAK", "CKSW__Zip_Postal_Code__c":"30009", "CKSW__Country__c":"US", "Alternate_Contact_First_Name__c":"", "Alternate_Contact_Last_Name__c":"", "Alternate_Contact_Email__c":"", "Entitlement_Text__c":null, "Updated_GMT_Timestamp":"2018-05-23T13:29:03.503Z", "notes":{ "caseNotes":[ { "Id":26541, "SFDCCaseNumber":"5324702956", "BCPCaseNumber":"1900010657", "SFDCTaskNumber":"", "BCPTaskNumber":"", "Note_Type":"All with Access", "Note":". Copied from NotePad, here are some supported languages:\nEnglish - Hello\nJapanese - こんにちは\nMandarin - 你好\nKorean - 안녕하세요\nSpanish - ¡hola!\nFrench - Bonjour\nPortuguese - Oi\ncheck if u can see it\n", "CreatedDate":"2018-05-22T10:35:16.013Z" } ], "taskNotes":[ { "Id":26543, "SFDCCaseNumber":null, "BCPCaseNumber":"", "SFDCTaskNumber":null, "BCPTaskNumber":"1900010657-191", "Note_Type":"All with Access", "Note":"TEST", "CreatedDate":"2018-05-23T13:29:03.503Z" } ] }, "partOrders":[ { "SFDCCaseNumber":null, "BCPCaseNumber":"1900010657", "SFDCTaskNumber":null, "BCPTaskId":"1900010657-191", "SFDCPartOrderID":null, "Legacy_Part_Order_Number__c":null, "BCPPartOrderID":"1900010657-191-1", "Logistic_Order_Identifier__c":null, "Street__c":"8601 DUNWOODY PL 610", "Street2__c":null, "City__c":"ALPHARETTA", "Country__c":null, "State__c":"GA", "Zip_Postal_Code__c":"30009", "Shipping_Condition_Code__c":"EX-Same Business day", "partLineOrders":[ { "SFDCCaseNumber":null, "BCPCaseNumber":"1900010657", "SFDCTaskNumber":null, "BCPTaskId":"1900010657-191", "SFDCPartOrderID":null, "Legacy_Part_Order_Number__c":null, "BCPPartOrderID":"1900010657-191-1", "SFDCPartOrderLineID":null, "Legacy_Record_ID__c":null, "BCPPartOrderLineID":"1900010657-191-1-1", "Functional_Equivalent_Part_Identifier__c":null, "Part_Description__c":null, "Logistics_Estimated_Arrival_TimeStamp__c":null, "Part_Shipped_TimeStamp__c":null, "Carrier_Name__c":null, "Part_Line_Status__c":"Recommended", "Ship_From_Plant_Code__c":null }, { "SFDCCaseNumber":null, "BCPCaseNumber":"1900010657", "SFDCTaskNumber":null, "BCPTaskId":"1900010657-191", "SFDCPartOrderID":null, "Legacy_Part_Order_Number__c":null, "BCPPartOrderID":"1900010657-191-1", "SFDCPartOrderLineID":null, "Legacy_Record_ID__c":null, "BCPPartOrderLineID":"1900010657-191-1-2", "Functional_Equivalent_Part_Identifier__c":null, "Part_Description__c":null, "Logistics_Estimated_Arrival_TimeStamp__c":null, "Part_Shipped_TimeStamp__c":null, "Carrier_Name__c":null, "Part_Line_Status__c":"Recommended", "Ship_From_Plant_Code__c":null } ] } ] } ]Response HTTP StatusThe following is the list of error codes understood by the API
HTTP Status Codes Summary 200 OK Client processed the request and return the status to caller Error MessageError Code Error Message 214 Partner not in BCP mode 224 Partner not found 234 No data found 244 Partner ID not found in allowed Partner BCP list. Please check with Administrator.