Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Request Payload:

Code Block
{
  "phonon-uuids": [
    {"<36 character alphanumeric Phonon UUID>"},
    {"<36 character alphanumeric Phonon UUID>"},
    ...
  ],
  "fetch-attempt": "ALL" // ALL = Fetch all attempts; LAST = Fetch only last attempt
}

Sample Request:

Code Block
languagejson
{
	"phonon-uuids": [
		"b2f9909e-9ac4-4e5c-9ac8-183f24ea9436"
	],
	"fetch-attempt": "ALL"
}

The Pull API has now been updated to take additional parameters in the Request Payload in the new version of the Pull API URL. This is done to ensure an additional layer of authentication or security step.

Panel
panelIconIda9513338-5a31-419a-b961-d24ebbf06b2f
panelIcon:Websi:
panelIconText:Websi:
bgColor#DEEBFF

Please contact your Customer Success Manager for the updated URL.

Pull API Version 2.0

Request Payload:

Code Block
{
    "security-id": "<64 character alphanumeric Security ID>",
    "flow-id": "<8 character alphanumeric Flow ID>",
     "phonon-uuids": [
         {"<36 character alphanumeric Phonon UUID>"},
         {"<36 character alphanumeric Phonon UUID>"},
          ...
  ],
  "fetch-attempt": "ALL" // ALL = Fetch all attempts; LAST = Fetch only last attempt
}

The Request Payload has been updated on Tuesday 9th May, 2023 with two new additional parameters namely Security ID and Flow ID.

Sample Request:

Code Block
languagejson
{ 
    	"security-id": "a1a465d2df243a7559bfdffb65ec7b7c8e60d1b230d482debb01917fb502a999437457061e066a3f5c6520cba6fc920965a3d84386d863610dcad56d39699999",
    "flow-id": "QG8k000AiH5Gzxxx",
	    "phonon-uuids": [
		"b2f9909e-9ac4-4e5c-9ac8-183f24ea9436"
	],
	
        "019060e2-2788-4b5a-a87f-c1508ee29999",
        "1591df5e-d434-4921-923e-32e04b8b9999"
    ],
    "fetch-attempt": "ALL"
}

Notes:

  1. Ensure valid JSON format

  2. Ensure IP is Whitelisted in your account

  3. Ensure your account validity is not expired

  4. Ensure number of Phonon UUIDs is less than Max data size (100 200 UUIDs is current max limit) - Response will contain api-response-message as ‘Max Data List Size Exceeded’ and no result will be fetched.

...