Skip to content

Latest commit

 

History

History
129 lines (116 loc) · 3.88 KB

endpoint_put_outbound_events_requests_reconcile.md

File metadata and controls

129 lines (116 loc) · 3.88 KB
Raw

PUT Outbound-Event Event Requests Reconcile

/outboundevents/<GUID>/events/<GUID>/requests/<GUID>

Marks a request in an event as reconciled if reconciled is set to true within the request body.

The user must be an integration administrator for the integration in order to perform this activity.

Request Header

Name Value Description
arena_session_id unique ID for session obtained from login
content-type application/json

Sample Request Body

Request body with reconciled set to true marks a Request in a specific event as reconciled.

{
    "reconciled": true
}

Response Codes

Code Description
200 Success
400 Failure

Response Header

Name Value Description
Content-Length number number of characters in response
Content-Type application/json content type of response
Date date today's date and time
Server ArenaSolutions
X-Arena-Next-Request-Limit-Reset date the scheduled time for resetting of the count
X-Arena-Requests-Remaining number how many calls left

Sample Responses

Marks as reconciled the specific request within an a specific event of a specific outbound-event integration.

/outboundevents/<GUID>/events/<GUID>/requests/<GUID>

{
    "guid": "N5P8D25M2T43M5OZP7I8",
    "postEvents": [
        {
            "additionalAttributes": [
                {
                    "apiName": "O6Q9E36N3UBTCVCZLWDP",
                    "fieldType": "FIXED_DROP_DOWN",
                    "guid": "O6Q9E36N3UBTCVCZLWDP",
                    "name": "Urgency",
                    "value": "Critical"
                },
                {
                    "apiName": "P7RAF47O4VCUDWD0MXE8",
                    "fieldType": "SINGLE_LINE_TEXT",
                    "guid": "P7RAF47O4VCUDWD0MXE8",
                    "name": "Expected Completion Date",
                    "value": "31/10/2024"
                }
            ],
            "category": {
                "guid": "SAUDI7AR7YHRAT5C5MA6"
            },
            "problem": "We need to reproduce the Ferrite Cores used in the Project 9708",
            "requestedAction": "Use The Artemis notes to relayer the fibers based on the 1874 Archives."
        }
    ],
    "preEvents": [
        {
            "additionalAttributes": [
                {
                    "apiName": "O6Q9E36N3UBTCVCZLWDP",
                    "fieldType": "FIXED_DROP_DOWN",
                    "guid": "O6Q9E36N3UBTCVCZLWDP",
                    "name": "Urgency",
                    "value": null
                },
                {
                    "apiName": "P7RAF47O4VCUDWD0MXE8",
                    "fieldType": "SINGLE_LINE_TEXT",
                    "guid": "P7RAF47O4VCUDWD0MXE8",
                    "name": "Expected Completion Date",
                    "value": null
                }
            ],
            "category": {
                "guid": "1J3MRGJ0G7Q0J2ELEVIF"
            },
            "problem": "We need to reproduce the Ferrite Cores used in the Apollo Program",
            "requestedAction": "Use The Artemis notes to relayer the fibers"
        }
    ],
    "reconciled": true,
    "reconciledDatetime": "2022-11-24T08:46:45Z",
    "reconciledUser": {
        "email": "[email protected]",
        "fullName": "Heidi Walker",
        "guid": "9RBUZOR8OFWFYH0JSIPJ"
    }
}

If the request body has a reconciled value of false, the response would resemble below.

{
    "guid": "4M6PUJM3JALK3M5G6PVS",
    "postEvents": [
        {
            "lifecycleStatus": {
                "type": "SUBMITTED"
            }
        }
    ],
    "preEvents": [
        {
            "lifecycleStatus": {
                "type": "PROMOTED"
            }
        }
    ],
    "reconciled": false
}