ApWorkFlow

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getApWorkFlow

post

Retrieve ApWorkFlow parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ApWorkFlowApInvoiceTypeintegerRequired

Responses

200

Successful operation.

application/json

post/getApWorkFlow

POST /nexum/627/2022.01/parameter/getApWorkFlow HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  },
  "ApWorkFlowApInvoiceType": 1
}

200

Successful operation.

{
  "ApWorkFlow": {
    "Event": [
      {
        "EntryId": 1,
        "Event": 3
      }
    ],
    "ApInvoiceType": 1
  },
  "MessageId": "getApWorkFlow"
}

getApWorkFlowSelectFields

post

Retrieve ApWorkFlow parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ApWorkFlowApInvoiceTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getApWorkFlowSelectFields

POST /nexum/627/2022.01/parameter/getApWorkFlowSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 221

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "ApWorkFlowApInvoiceType": 0,
  "SelectableFields": {
    "IncludeAllApWorkFlowFields": true
  }
}

200

Successful operation.

{
  "ApWorkFlow": {
    "ApInvoiceType": 0,
    "Event": [
      {
        "EntryId": 1,
        "Event": 3
      }
    ]
  },
  "MessageId": "getApWorkFlowSelectFields"
}

getApWorkFlowPagedList

post

Retrieve ApWorkFlow parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getApWorkFlowPagedList

POST /nexum/627/2022.01/parameter/getApWorkFlowPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "ApWorkFlow": [],
  "Token": null,
  "MessageId": "getApWorkFlowPagedList"
}

getApWorkFlowListSelectFields

post

Retrieve ApWorkFlow parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/getApWorkFlowListSelectFields

POST /nexum/627/2022.01/parameter/getApWorkFlowListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 193

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllApWorkFlowFields": true
  }
}

200

Successful operation.

{
  "ApWorkFlowList": [],
  "MessageId": "getApWorkFlowListSelectFields"
}

searchApWorkFlowSelectFields

post

Search ApWorkFlow parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

post/searchApWorkFlowSelectFields

POST /nexum/627/2022.01/parameter/searchApWorkFlowSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllApWorkFlowFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "ApWorkFlowList": [],
  "MessageId": "searchApWorkFlowSelectFields"
}

getApWorkFlowPagedListSelectFields

post

Retrieve ApWorkFlow parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getApWorkFlowPagedListSelectFields

POST /nexum/627/2022.01/parameter/getApWorkFlowPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 272

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllApWorkFlowFields": true
  }
}

200

Successful operation.

{
  "ApWorkFlow": [
    {
      "ApInvoiceType": 0,
      "Event": [
        {
          "EntryId": 1,
          "Event": 3
        }
      ]
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getApWorkFlowPagedListSelectFields"
}

searchApWorkFlowPagedSelectFields

post

Search ApWorkFlow parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchApWorkFlowPagedSelectFields

POST /nexum/627/2022.01/parameter/searchApWorkFlowPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 283

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "IncludeAllApWorkFlowFields": true
  }
}

200

Successful operation.

{
  "ApWorkFlow": [
    {
      "ApInvoiceType": 0,
      "Event": [
        {
          "EntryId": 1,
          "Event": 3
        }
      ]
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchApWorkFlowPagedSelectFields"
}

updateApWorkFlowByID

post

Update ApWorkFlow parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ApWorkFlowApInvoiceTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateApWorkFlowByID

POST /nexum/627/2022.01/parameter/updateApWorkFlowByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ApWorkFlowApInvoiceType": 1,
  "ApWorkFlowUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateApWorkFlowByID"
}