Jump to

• Request
• Response
• Examples

Get advanced search attributes

get

/api/v4/search/attributes/{objectType}

Versions Supported:

v4

Request

Path Parameters

• objectType(required): string
  Specify the type of object in DaaS; for example,company,contact.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: object

Show Source

• advanceSearchAttributes: array advanceSearchAttributes

{
    "properties":{
        "advanceSearchAttributes":{
            "items":{
                "$ref":"#/components/schemas/AdvanceSearchAttrInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : advanceSearchAttributes

Type: array

Show Source

• Array of: object AdvanceSearchAttrInfo

{
    "items":{
        "$ref":"#/components/schemas/AdvanceSearchAttrInfo"
    },
    "type":"array"
}

Nested Schema : AdvanceSearchAttrInfo

Type: object

Show Source

• attributeDisplayName: string
• attributeName: string
• defaultOperator: string
  Allowed Values: [ "BW", "CO", "EQ", "EW", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "SW" ]
• isautosuggest: boolean
• isInternal: boolean
• operators: array operators
• pickList: array pickList
• targetAttributeName: string

{
    "properties":{
        "attributeDisplayName":{
            "type":"string"
        },
        "attributeName":{
            "type":"string"
        },
        "defaultOperator":{
            "$ref":"#/components/schemas/Operators"
        },
        "isautosuggest":{
            "type":"boolean"
        },
        "isInternal":{
            "type":"boolean"
        },
        "operators":{
            "items":{
                "$ref":"#/components/schemas/Operators"
            },
            "type":"array"
        },
        "pickList":{
            "items":{
                "$ref":"#/components/schemas/Lookup"
            },
            "type":"array"
        },
        "targetAttributeName":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : operators

Type: array

Show Source

• Array of: string
  Allowed Values: [ "BW", "CO", "EQ", "EW", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "SW" ]

{
    "items":{
        "$ref":"#/components/schemas/Operators"
    },
    "type":"array"
}

Nested Schema : pickList

Type: array

Show Source

• Array of: object Lookup

{
    "items":{
        "$ref":"#/components/schemas/Lookup"
    },
    "type":"array"
}

Nested Schema : Lookup

Type: object

Show Source

• displayCode: string
• displayValue: string
• value: string

{
    "properties":{
        "displayCode":{
            "type":"string"
        },
        "displayValue":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "type":"object"
}

404 Response

Requested resource could not be found.

500 Response

An unexpected error occurred during the request.

Back to Top

Examples

Example Request:

/api/v4/search/attributes/company

Example Output:

 {
   "advanceSearchAttributes": [
     {
 	  "attributeDisplayName": "Location Type",
       "attributeName": "company.status_ind",
       "defaultOperator": "EQ",
       "operators": [
         "EQ",
         "NOTEQ",
         "NOTNULL"
       ],
       "pickList": [
         {
           "displayValue": "Single Location",
           "value": "0"
         },
         {
           "displayValue": "Headquarters",
           "value": "1"
         },
         {
           "displayValue": "Branch",
           "value": "2"
         }
       ],
       "isautosuggest": "false"
     },
     {
       "attributeDisplayName": "Global Ultimate Business Name",
       "attributeName": "company.gl_ult_nam",
       "defaultOperator": "CO",
       "operators": [
         "SW",
         "CO",
         "NOTCO",
         "NOTIN",
         "NOTNULL"
       ],
       "isautosuggest": "true"
     }
   ]
  }

Back to Top