Get MCPS Query

Returns list of MCPSQuery objects in metadata.

Request Method Service URL
GET /api-metadata/v1/{access-key}/metadata/mcpsqueries
Request Headers

Content-Type=application/json

Query Parameters

  • q: Used to search by metadata attributes.

    Supported Operators:

    • EQUALS
    • NOT_EQUALS
    • NULL
    • NOT_NULL
    • CONTAINS (String attributes only)
    • NOT_CONTAINS (String attributes only)
    • GREATER_THAN (Number attributes only)
    • GREATER_EQUAL_THAN (Number attributes only)
    • LESS_THAN (Number attributes only)
    • LESS_EQUAL_THAN (Number attributes only)

Examples

Retrieve a list of MCPSQuery objects.

Request URL

http://{AccountURL}/api-metadata/v1/e2a7a0df2410470d85ef69c8dad2bdb8/metadata/mcpsqueries

Response Body Example

{
  "MCPSQuery": {
    "tenantId": 100,
    "name": "selectCustomer",
    "versionTS": null,
    "description": null,
    "active": null,
    "lastModifiedBy": null,
    "createdTS": null,
    "uniqueId": "selectCustomer",
    "operation": {
      "ctype": ".SetOperation",
      "name": "TopOp",
      "tenantId": 21,
      "uniqueId": "selectCustomer",
      "operands": [
        {
          "ctype": ".ObjectSet",
          "tenantId": 100,
          "name": "C1",
          "versionTS": null,
          "description": "C1",
          "active": null,
          "lastModifiedBy": null,
          "createdTS": null,
          "objectName": "customer",
          "uniqueId": "selectCustomerQuery_customer",
          "outputAttributes": [
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "SourceID",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "SourceCustomerID",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "SourceAccountID",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "SourceAssociateID",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "SourceSignUpOrganizationID",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "Email",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "AlternateEmails",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "Phone",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "MobilePhone",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "AlternatePhones",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "Gender",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "okToEmail",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "okToCall",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "okToText",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "okToNotify",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "okToMail",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "EmailFrequency",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "Properties",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "RegistrationTS",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "IsActive",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "Status",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "Type",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "FirstName",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "MiddleName",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "Suffix",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "Prefix",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "LastName",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "BirthDate",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "BirthMonth",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "BirthDay",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "BirthYear",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "Age",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "LoyaltyNumber",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "OriginalChannel",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "PrimaryLanguage",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "CreatedBy",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "ModifiedBy",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "CreatedTS",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "ModifiedTS",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "RowCreatedTS",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "RowModifiedTS",
              "alias": null
            },
            {
              "atype": ".ReferenceAttribute",
              "tableName": "C1",
              "attributeName": "favoriteBrand",
              "alias": null
            }
          ],
          "distinct": false,
          "criteria": {
            "ctype": ".Criteria",
            "operator": "OR",
            "operands": [
              {
                "ctype": ".Criteria",
                "operator": "NOT_NULL",
                "operands": [
                  {
                    "ctype": ".ReferenceAttribute",
                    "tableName": "C1",
                    "attributeName": "ID",
                    "alias": null
                  }
                ]
              }
            ]
          },
          "havings": null,
          "groupBy": null,
          "sortBy": null,
          "occurrence": null,
          "objectJoin": null,
          "parameters": null
        },
        null
      ],
      "operator": "UNION",
      "distinct": false,
      "outputAttributes": [
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "SourceID",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "SourceCustomerID",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "SourceAccountID",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "SourceAssociateID",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "SourceSignUpOrganizationID",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "Email",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "AlternateEmails",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "Phone",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "MobilePhone",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "AlternatePhones",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "Gender",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "okToEmail",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "okToCall",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "okToText",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "okToNotify",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "okToMail",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "EmailFrequency",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "Properties",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "RegistrationTS",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "IsActive",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "Status",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "Type",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "FirstName",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "LastName",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "BirthDate",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "BirthMonth",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "BirthDay",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "BirthYear",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "Age",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "LoyaltyNumber",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "OriginalChannel",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "PrimaryLanguage",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "CreatedBy",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "ModifiedBy",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "CreatedTS",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "ModifiedTS",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "RowCreatedTS",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "RowModifiedTS",
          "alias": null
        },
        {
          "atype": ".ReferenceAttribute",
          "tableName": "C1",
          "attributeName": "favoriteBrand",
          "alias": null
        }
      ],
      "joinConditions": [
        
      ]
    }
  }
}

Examples

Filter MCPS Queries by query name that contains "Query4".

Request URL Example

http://{AccountURL}/api-metadata/v1/e2a7a0df2410470d85ef69c8dad2bdb8/metadata/mcpsqueries?q=[{"operator":"CONTAINS","attribute":"name","value":"QUERY4"}]

Response Example

{
    "MCPSQuery": {
        "tenantId": 10,
        "name": "example",
        "uniqueId": "example",
        "operation": {
            "ctype": ".SetOperation",
            "name": "example",
            "tenantId": 10,
            "uniqueId": "example",
            "operands": [{
                "ctype": ".ObjectSet",
                "tenantId": 10,
                "name": "C1",
                "description": "C1",
                "objectName": "Customer",
                "uniqueId": "C1",
                "outputAttributes": [{
                    "atype": ".ReferenceAttribute",
                    "tableName": "C1",
                    "attributeName": "ID"
                }],
                "distinct": false,
                "criteria": {
                    "ctype": ".Criteria",
                    "operator": "AND",
                    "operands": [{
                        "ctype": ".Criteria",
                        "operator": "EQUALS",
                        "operands": [{
                            "ctype": ".ReferenceAttribute",
                            "tableName": "C1",
                            "attributeName": "name"
                        }, {
                            "ctype": ".StaticAttribute",
                            "data": "QUERY4"
                        }]
                    }, {
                        "ctype": ".Criteria",
                        "operator": "EQUALS",
                        "operands": [{
                            "ctype": ".ReferenceAttribute",
                            "tableName": "C1",
                            "attributeName": "LastName"
                        }, {
                            "ctype": ".StaticAttribute",
                            "data": "Smith"
                        }]
                    }]
                }
            }, null],
            "operator": "INTERSECTION",
            "distinct": false,
            "outputAttributes": [{
                "atype": ".ReferenceAttribute",
                "tableName": "C1",
                "attributeName": "ID"
            }],
            "joinConditions": []
        }
    }
}

Learn more

MCPS Query Language Definition

Data Query API