Versions Compared

Old Version 31

changes.mady.by.user Akash Kumar Jaiswal

Saved on

compared with

New Version 32

changes.mady.by.user Akash Kumar Jaiswal

Saved on

Key

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

...

OperationMethodAPI EndpointExample Request Payload
Create TransactionPOST/rest/transaction


Code Block
titleCreate Transaction
collapsetrue
{ "Transaction": { "entityName": "Data Transaction", "description": "To transfer benefits data.", "templateId": "1111111111100" } }


Create Transaction with ParametersPOST/rest/transactiontransaction


Code Block
titleCreate Transaction with Parameters
collapsetrue
{ "Transaction": { "entityName": "Data Transaction", "description": "To transfer benefits data.", "templateId": "547658658658658", "variableInfo": "{\"param1\" : \"value1\",\"param2\":\"value2\"}" } }


Update TransactionPUT/rest/transaction/{transactionId}


Code Block
titleUpdate Transaction
collapsetrue
{ "Transaction": { "description": "To transfer benefits data from xml file.", } }


Update Transaction ParametersPUT/rest/transaction/{transactionId}


Code Block
titleUpdate Transaction Parameters
collapsetrue
{ "Transaction": { "variableInfo": "{\"param1\" : \"value1\",\"param2\":\"value2\"}" } }


DELETEDELETE/rest/transaction/{transactionId}EMPTY


APIs for Managing Transaction for Custom Template 

OperationMethodAPI EndpointExample Request PayloadExample Response Payload
Create TransactionPOST/rest/transaction


Code Block
titleCreate Transaction
collapsetrue
{
   "Transaction":{
      "entityName":"MM_TM_Payroll_Submit_File Transaction",
      "description":"To transfer benefits data.",
      "partner":{
         "id":11494913182612
      },
      "template":{
         "id":11572856933900
      },
      "status":601,
      "type":504,
      "direction":3200,
      "srcTrigger":"onformsubmit",
      "processType":700,
      "company":{
         "id":1
      },
      "contactUser":"james.paul@abc.com",
      "metadata":[
         {
            "activityId":"192168001115157614705356800011",
            "sequenceId":16,
            "sequenceType":"Mapping",
            "type":"DataMapping",
            "isUniqueName":false
         },
         {
            "activityId":"192168001115157614699843700010",
            "sequenceId":13,
            "sequenceType":"Schema",
            "type":"XMLSchema",
            "isUniqueName":false
         },
         {
            "activityId":"192168001115157614693311500006",
            "sequenceId":5,
            "sequenceType":"Schema",
            "type":"AdvanceTextSchema",
            "isUniqueName":false
         }
      ]
   }
}

To identify the sequence ID for each steps, you need to run the Get Step Info API.



Code Block
titleCreate Transaction
collapsetrue
{
   "Transaction":{
 	"id":"1234568,
     "entityName":"MM_TM_Payroll_Submit_File Transaction",
      "description":"To transfer benefits data.",
      "partner":{
         "id":11494913182612
      },
      "template":{
         "id":11572856933900
      },
      "status":601,
      "type":504,
      "direction":3200,
      "srcTrigger":"onformsubmit",
      "processType":700,
      "company":{
         "id":1
      },
      "contactUser":"james.paul@abc.com",
      "metadata":[
         {
            "activityId":"192168001115157614705356800011",
            "sequenceId":16,
            "sequenceType":"Mapping",
            "type":"DataMapping",
            "isUniqueName":false
         },
         {
            "activityId":"192168001115157614699843700010",
            "sequenceId":13,
            "sequenceType":"Schema",
            "type":"XMLSchema",
            "isUniqueName":false
         },
         {
            "activityId":"192168001115157614693311500006",
            "sequenceId":5,
            "sequenceType":"Schema",
            "type":"AdvanceTextSchema",
            "isUniqueName":false
         }
      ]
   }
}


Get Step InfoGET

/rest/transactiontemplate/getactivitiesinfo/

{templateId}/{processFlowId}

EMPTY


Code Block
titleCreate Transaction with Parameters
collapsetrue
[
   {
      "id":"010000000208153912375678500006",
      "name":"PK_Read_Input_Data",
      "type":"FtpSource",
      "baseType":"Source",
      "trigger":true,
      "action":false,
      "include":true,
      "label":"PK_Read_Input_Data",
      "serviceDisplayName":"Source",
      "triggerLayout":false,
      "actionLayout":false,
      "eventContextEnabled":true,
      "references":null,
      "sequenceId":1,
      "formType":"TEMPLATE"
   },
   {
      "id":"010000000208153912397741400010",
      "name":"PK_Excel_Schema_Src",
      "type":"TextSchema",
      "baseType":"SourceSchema",
      "trigger":false,
      "action":false,
      "include":true,
      "label":"PK_Excel_Schema_Src",
      "serviceDisplayName":"Source Layout",
      "triggerLayout":false,
      "actionLayout":false,
      "eventContextEnabled":false,
      "references":[
         {
            "id":"010000000208153912375678500006",
            "name":"PK_Read_Input_Data",
            "type":"FtpSource",
            "baseType":"Source",
            "trigger":true,
            "action":false,
            "include":true,
            "label":"PK_Read_Input_Data",
            "serviceDisplayName":"Source",
            "triggerLayout":false,
            "actionLayout":false,
            "eventContextEnabled":true,
            "references":null,
            "sequenceId":1,
            "formType":"TEMPLATE"
         }
      ],
      "sequenceId":2,
      "formType":"TEMPLATE"
   },
   {
      "id":"010000000208153912384088200008",
      "name":"PK_Write_Target_Data",
      "type":"FtpTarget",
      "baseType":"Target",
      "trigger":false,
      "action":true,
      "include":true,
      "label":"PK_Write_Target_Data",
      "serviceDisplayName":"Target",
      "triggerLayout":false,
      "actionLayout":false,
      "eventContextEnabled":false,
      "references":null,
      "sequenceId":3,
      "formType":"TEMPLATE"
   },
   {
      "id":"010000000208153912399192000012",
      "name":"PK_Excel_Schema_Target",
      "type":"TextSchema",
      "baseType":"TargetSchema",
      "trigger":false,
      "action":false,
      "include":true,
      "label":"PK_Excel_Schema_Target",
      "serviceDisplayName":"Target Layout",
      "triggerLayout":false,
      "actionLayout":false,
      "eventContextEnabled":false,
      "references":[
         {
            "id":"010000000208153912384088200008",
            "name":"PK_Write_Target_Data",
            "type":"FtpTarget",
            "baseType":"Target",
            "trigger":false,
            "action":true,
            "include":true,
            "label":"PK_Write_Target_Data",
            "serviceDisplayName":"Target",
            "triggerLayout":false,
            "actionLayout":false,
            "eventContextEnabled":false,
            "references":null,
            "sequenceId":3,
            "formType":"TEMPLATE"
         }
      ],
      "sequenceId":4,
      "formType":"TEMPLATE"
   },
   {
      "id":"010000000208153912414793100013",
      "name":"PK_Mapping",
      "type":"DataMapping",
      "baseType":"DataMapping",
      "trigger":false,
      "action":false,
      "include":true,
      "label":"Mapping",
      "serviceDisplayName":"Mapping",
      "triggerLayout":false,
      "actionLayout":false,
      "eventContextEnabled":false,
      "references":null,
      "sequenceId":5,
      "formType":"TEMPLATE"
   }
]



APIs for Managing Schema and Mapping

...