Creating New Calls

ASM API Quick Reference Guide

Start a new Request

  1. In Postman, select 'New' in the top left-hand corner.

  2. Select HTTP from the dialogue window and give the request the name of Call Create

Creating New Calls

  1. Method: POST

    • URL: {{SystemURLTest}}/alemba.api/api/v2/call

      • Full URL, if desired: https://<yourservername>/<yourASMsystemname>/alemba.api/api/v2/call

    • Headers: Content-Type: application/json

    • Authorization: Bearer {{Login_Token}}

    • Body: Raw

    • Body: JSON data with required fields such as IpkStatus, IpkStream, Partition, Type, Urgency, Priority, Impact, Description, Service, User, and ReceivingGroup.

    The Body of the HTTP request is where you enter the data/changes that you want to enact on the call. The Body is written in JSON. See Jargon Buster to read more about JSON.

There are a number of parameters that MUST be provided when creating a new call such as:

  • IpkStatus

  • IpkStream

  • Partition

  • Type

  • Urgency

  • Priority

  • Impact

  • Description

  • DescriptionHtml

  • Service

  • User

  • ReceivingGroup

Please note:

  1. Where you have rich text fields (HTML), you always need to provide the FieldName value and the FieldNameHtml value.

  2. Custom fields will always have a Ext_ in front of their normal name value

  3. Names with spaces will have spaces removed e.g. B Inc External Supplier Name becomes Ext_BIncExternalSupplierName

The JSON body may look like this :

{

"CustomString2": "INC5139834",

"Description": "Description",

"DescriptionHtml": "<p>Description</p>",

"Ext_BIncExternalSupplierName": "SupplierName",

"Impact": 10,

"IpkStatus": 1,

"IpkStream": 0,

"Location": 308,

"Priority":4,

"Partition": 1,

"ReceivingGroup":80,

"Service": 24636,

"Type": 5,

"Urgency": 9,

"User": 38

}

Last updated

Was this helpful?