Jump to

• Request
• Response
• Examples

Return attributes for a source

get

/api/{version}/mapping/attributes/{source}

Versions Supported:

v4

Request

Path Parameters

• source: string
  The type of attributes to be retrieved; for example, daas, fcrm.

Query Parameters

• attributetype: string
• ignoresubscription: boolean
• inActive: string
• mapMode: string
• object: string
  Specify the type of object in DaaS; for example, company.

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

Catalog attribute list.

Show Source

• catalogAttributes(optional): array catalogAttributes

{
    "properties":{
        "catalogAttributes":{
            "items":{
                "$ref":"#/components/schemas/CatalogAttributes"
            },
            "type":"array"
        }
    },
    "description":"Catalog attribute list.",
    "type":"object"
}

Nested Schema : catalogAttributes

Type: array

Show Source

• Array of: object CatalogAttributes

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

Nested Schema : CatalogAttributes

Type: object

Show Source

• active(optional): string
• attributeDisplayName(optional): string
• attributeId(optional): integer(int64)
• attributeMsgKey(optional): string
• attributeName(optional): string
• isautosuggest(optional): boolean
• objectName(optional): string
• operations(optional): array operations
• pickListValues(optional): array pickListValues
• searchReturn(optional): boolean
• tierLevel(optional): string

{
    "properties":{
        "active":{
            "type":"string"
        },
        "attributeDisplayName":{
            "type":"string"
        },
        "attributeId":{
            "format":"int64",
            "type":"integer"
        },
        "attributeMsgKey":{
            "type":"string"
        },
        "attributeName":{
            "type":"string"
        },
        "isautosuggest":{
            "type":"boolean"
        },
        "objectName":{
            "type":"string"
        },
        "operations":{
            "items":{
                "$ref":"#/components/schemas/Operator"
            },
            "type":"array"
        },
        "pickListValues":{
            "items":{
                "$ref":"#/components/schemas/Lookup"
            },
            "type":"array"
        },
        "searchReturn":{
            "type":"boolean"
        },
        "tierLevel":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : operations

Type: array

Show Source

• Array of: string
  Allowed Values: [ "BETWEEN", "CONTAINS", "DOESNOTEXIST", "ENDSWITH", "EQUALS", "EXISTS", "GREATERTHAN", "GREATERTHANEQUALS", "ISBLANK", "ISNOTBLANK", "LESSTHAN", "LESSTHANEQUALS", "LIKE", "NOTBETWEEN", "RANGE", "STARTSWITH" ]

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

Nested Schema : pickListValues

Type: array

Show Source

• Array of: object Lookup

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

Nested Schema : Lookup

Type: object

Show Source

• displayCode(optional): string
• displayValue(optional): string
• value(optional): 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 request.

Back to Top

Examples

Example Request:

/api/v4/mapping/attributes/daas?object=COMPANY

Example Output:

{
"catalogAttributes": [{
"attributeDisplayName": "Company ID",
"attributeId": "11385",
"attributeName": "id",
"objectName": "COMPANY",
"tierLevel": "STANDARD"
}, {
"attributeDisplayName": "Business Name",
"attributeId": "11386",
"attributeName": "name.display_name",
"objectName": "COMPANY",
"tierLevel": "STANDARD"
}, {
"attributeDisplayName": "OrganizationType",
"attributeId": "11387",
"attributeName": "info.organization_type",
"objectName": "COMPANY",
"tierLevel": "STANDARD"
}, ...]
}

Error Response Details:

{"errorMessage": "DCS-1 : The version of the service is not supported. Action: Provide the supported version for accessing the service." }

Back to Top