Lookup properties details

Lookup properties details

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API arealookupsproperties.json
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
Model StructureYesName of model requiredmodelstructure=lookupspropertydetailsUsing data models
CompanyYesThe company numbercompany=16
UUIDNoThe record UUIDUUID=41B615A673484F77A31EEEB07746FD54

Example request (OAuth 2.0):

Multiple records
Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/jsonapi/lookupsproperties.json?&company=16&modelstructure=lookupspropertydetails&version=6

Example request (legacy username/password):

http://&lt;SERVER&gt;/jsonapi/lookupsproperties.json?&company=16&modelstructure=lookupspropertydetails&version=6&user=<username>&password=<password>
Specifying a single record
Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/jsonapi/lookupsproperties.json?&company=16&modelstructure=lookupspropertydetails&UUID=41B615A673484F77A31EEEB07746FD54&version=6

Example request (legacy username/password):

http://&lt;SERVER&gt;/jsonapi/lookupsproperties.json?&company=16&modelstructure=lookupspropertydetails&UUID=41B615A673484F77A31EEEB07746FD54&version=6&user=<username>&password=<password>

or
Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 1,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "synapiversion": 3.8,
  "data": [
    {
      "lookupspropertiesUuid": "41B615A673484F77A31EEEB07746FD54",
      "lookupspropertiesTimestampModified": 1385820617,
      "lookupspropertiesRecordVersionNumber": 0,
      "lookupspropertiesUdfLabel": "* Activity Types in Activities",
      "lookupspropertiesOriginalName": "* NoteType in Notes *",
      "lookupspropertiesAliasUuid": "20202020202020202020202020202020",
      "lookupspropertiesSettingsAllowed": false,
      "lookupspropertiesUdf": false,
      "lookupspropertiesMandatoryLocked": false,
      "lookupspropertiesUdfCategory": "STANDARD",
      "lookupspropertiesUdfField": 0,
      "lookupspropertiesTableNum": 81,
      "lookupspropertiesSelfFieldNum": 20,
      "lookupspropertiesCompany": 16,
      "lookupspropertiesInactive": false,
      "lookupspropertiesUdfFieldType": 0,
      "lookupsproperties_udfoptions": "",
      "lookupspropertiesUdfDisplayOrder": "",
      "lookupspropertiesNotes": "",
      "lookupspropertiesPulldown": false,
      "lookupspropertiesAllowNew": false,
      "lookupspropertiesAllowNone": false,
      "lookupspropertiesRestrictInputToSpecifiedValues": false,
      "lookupspropertiesUdfMandatory": false,
      "lookupspropertiesUdfFormat": "",
      "lookupspropertiesUseParentContext": false,
      "lookupspropertiesParentUuid": "20202020202020202020202020202020"
    }
  ]
}