Salesforce B2C Commerce 24.7 > Open Commerce API 23.2 > Data API resources 23.2

SystemObjectDefinitionSearch resource (Data API 23.2)

Summary

Http Method Resource Description
POST /system_object_definition_search

Searches for system objects.

The query attribute specifies a complex query that can be used to narrow down the search. These are the list of searchable attributes:

  • object_type - String
  • display_name - Localized<String>
  • description - Localized<String>
  • read_only - Boolean

The output of the query can also be sorted. These are the list of sortable attributes:

  • object_type - String
  • display_name - Localized<String>
  • description - Localized<String>
  • read_only - Boolean

Search SystemObjects

Searches for system objects.

The query attribute specifies a complex query that can be used to narrow down the search. These are the list of searchable attributes:

  • object_type - String
  • display_name - Localized<String>
  • description - Localized<String>
  • read_only - Boolean

The output of the query can also be sorted. These are the list of sortable attributes:

  • object_type - String
  • display_name - Localized<String>
  • description - Localized<String>
  • read_only - Boolean

Url

POST https://hostname:port/dw/data/v23_2/system_object_definition_search

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Request Document

SearchRequest

Response Document

ObjectTypeDefinitionSearchResult

In case of a failure Fault Document is returned.

Faults

Status Type Arguments Description
400 MalformedSearchParameterException   Thrown if the query is ill-formed.

Sample

REQUEST:
POST /s/-/dw/data/v23_2/system_object_definition_search HTTP/1.1
Host: example.com
Authorization: Bearer a5b6eb0d-8312-41a3-88f3-2c53c4507367
Accept: application/json

{
    "query" : {
        "text_query": {
            "fields": ["object_type", "description"],
            "search_phrase": "Product"
        }
    },
    "select" : "(**)"
}

RESPONSE:
HTTP/1.1 200 OK
Content-Length: 67
Content-Type: application/json; charset=UTF-8

{
  "_v" : "23.2",
  "_type" : "system_object_search_result",
  "count" : 2,
  "hits" : [
    {
       "_type" : "system_object",
       "object_type" : "Product",
       "display_name" : {
          "default" : "Product"
       },
       "description" : {
          "default" : "Object type representing products."
       },
       "read_only" : false,
       "queryable" : false,
       "content_object": false,
       "attribute_definition_count" : 166,
       "attribute_group_count" : 5,
       "link" : "http://example.com/s/-/dw/data/v23_2/system_object_definitions/Product"
    },
    {
       "_type" : "system_object",
       "object_type" : "ProductActiveData",
       "display_name" : {
          "default" : "Product Active Data"
       },
       "description" : {
          "default" : "Object type representing active data for Products."
       },
       "read_only" : false,
       "queryable" : false,
       "content_object": false,
       "attribute_definition_count" : 51,
       "attribute_group_count" : 2,
       "link" : "http://example.com/s/-/dw/data/v23_2/system_object_definitions/ProductActiveData"
    }
  ],
  "query" : { "text_query": { "fields": ["object_type", "description"], "search_phrase": "Product" } },
  "select": "(**)",
  "start" : 0,
  "total" : 2
}

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.