Create - with parent context

Create - with parent context

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API arealookups.json
ActionYesThe action to performaction=create
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
JSON InputMandatoryDescriptionExamples
lookupsLookupValueYesLookup value"lookupsLookupValue":"New Dept"
lookupsLookupsPropertiesUuidYesLookup properties UUID"lookupsLookupsPropertiesUuid":"263CD0A8DCDF4BFAAB50A1560B17E010"
lookupsContextValueYesParent context"lookupsContextValue":"Departments"

Note: Parent context is used when the lookup you are adding a validation item to has a parent lookup. In this case each new lookup item has to be associated to a lookup item that already exists in the parent lookup.

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/lookups.json?action=create&&input={"data":[{"lookupsLookupValue":"New Dept","lookupsLookupsPropertiesUuid":"263CD0A8DCDF4BFAAB50A1560B17E010","lookupsContextValue":"Departments"}]}&version=6

Example request (legacy username/password):

http://<SERVER>/jsonapi/lookups.json?action=create&&input={"data":[{"lookupsLookupValue":"New Dept","lookupsLookupsPropertiesUuid":"263CD0A8DCDF4BFAAB50A1560B17E010","lookupsContextValue":"Departments"}]}&version=6&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "data processed successfully.",
  "warningmessage": "",
  "success": true,
  "synapiversion": 3.9,
  "data": [
    {
      "lookupsUuid": "3629761F72A19E448BD943F155DBE096",
      "lookupsTimestampModified": 1648638222,
      "lookupsRecordVersionNumber": 0
    }
  ]
}