Jump to

• Request
• Response
• Examples

Get an object type

get

/crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}

Request

Path Parameters

• ObjectTypeCode(required): string
  Specifies the Object type or category that is relevant in a given user context. For example Account, Contact, Lead, and so on.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : userContextObjectTypes-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• Enabled: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

  Indicates whether the object type is enabled for user context. The default value is 'Y'.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• objectConfigs: array Object Configurations
  Title: Object Configurations

  The object configurations resource is used to view and update an object configuration.
• objectCriteria: array Object Criteria
  Title: Object Criteria

  The object criteria resource is used to view, create, update, and delete a configuration and mapping. It is used to determine the criteria to query the elastic data store and workspace saved searches.
• ObjectTypeCode: string
  Title: Object Type Code

  Maximum Length: 30

  Specifies the Object type or category that is relevant in a given user context. For example Account, Contact, Lead, and so on.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The object version number is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• relatedObjects: array Related Objects
  Title: Related Objects

  The related objects resource is used to view and update a related object.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the object type is enabled for user context. The default value is 'Y'.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the Object type or category that is relevant in a given user context. For example Account, Contact, Lead, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "objectConfigs":{
            "title":"Object Configurations",
            "type":"array",
            "description":"The object configurations resource is used to view and update an object configuration.",
            "items":{
                "$ref":"#/components/schemas/userContextObjectTypes-objectConfigs-item-response"
            }
        },
        "objectCriteria":{
            "title":"Object Criteria",
            "type":"array",
            "description":"The object criteria resource is used to view, create, update, and delete a configuration and mapping. It is used to determine the criteria to query the elastic data store and workspace saved searches.",
            "items":{
                "$ref":"#/components/schemas/userContextObjectTypes-objectCriteria-item-response"
            }
        },
        "relatedObjects":{
            "title":"Related Objects",
            "type":"array",
            "description":"The related objects resource is used to view and update a related object.",
            "items":{
                "$ref":"#/components/schemas/userContextObjectTypes-relatedObjects-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Object Configurations

Type: array

Title: Object Configurations

The object configurations resource is used to view and update an object configuration.

Show Source

• Array of: object userContextObjectTypes-objectConfigs-item-response

{
    "title":"Object Configurations",
    "type":"array",
    "description":"The object configurations resource is used to view and update an object configuration.",
    "items":{
        "$ref":"#/components/schemas/userContextObjectTypes-objectConfigs-item-response"
    }
}

Nested Schema : Object Criteria

Type: array

Title: Object Criteria

The object criteria resource is used to view, create, update, and delete a configuration and mapping. It is used to determine the criteria to query the elastic data store and workspace saved searches.

Show Source

• Array of: object userContextObjectTypes-objectCriteria-item-response

{
    "title":"Object Criteria",
    "type":"array",
    "description":"The object criteria resource is used to view, create, update, and delete a configuration and mapping. It is used to determine the criteria to query the elastic data store and workspace saved searches.",
    "items":{
        "$ref":"#/components/schemas/userContextObjectTypes-objectCriteria-item-response"
    }
}

Nested Schema : Related Objects

Type: array

Title: Related Objects

The related objects resource is used to view and update a related object.

Show Source

• Array of: object userContextObjectTypes-relatedObjects-item-response

{
    "title":"Related Objects",
    "type":"array",
    "description":"The related objects resource is used to view and update a related object.",
    "items":{
        "$ref":"#/components/schemas/userContextObjectTypes-relatedObjects-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : userContextObjectTypes-objectConfigs-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DataSourceCode: string
  Title: Data Source Code

  Maximum Length: 30

  The data source code for sources where user context information is captured and stored.
• Enabled: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

  Indicates whether the object for the data source is enabled for user context.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• objectConfigDetails: array Object Configuration Details
  Title: Object Configuration Details

  The object configuration details resource is used to view and update the object configuration.
• ObjectMappingCode: string
  Title: Object Mapping Code

  Maximum Length: 150

  The name of the object type used for the data source.
• ObjectTypeCode: string
  Title: Object Type Code

  Maximum Length: 30

  Specifies the Object type or category that is relevant in a given user context. For example Account, Contact, Lead, and so on.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The object version number is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• ObjectWeight: integer (int32)
  Title: Object Weight

  The weight or relevance of a data source. This is used to calculate the relevance score.
• Score: integer (int64)
  Title: Score

  The score of a relevant item.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DataSourceCode":{
            "title":"Data Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The data source code for sources where user context information is captured and stored.",
            "nullable":false,
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the object for the data source is enabled for user context.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectMappingCode":{
            "title":"Object Mapping Code",
            "maxLength":150,
            "type":"string",
            "description":"The name of the object type used for the data source.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the Object type or category that is relevant in a given user context. For example Account, Contact, Lead, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ObjectWeight":{
            "title":"Object Weight",
            "type":"integer",
            "description":"The weight or relevance of a data source. This is used to calculate the relevance score.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"The score of a relevant item.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":10
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "objectConfigDetails":{
            "title":"Object Configuration Details",
            "type":"array",
            "description":"The object configuration details resource is used to view and update the object configuration.",
            "items":{
                "$ref":"#/components/schemas/userContextObjectTypes-objectConfigs-objectConfigDetails-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Object Configuration Details

Type: array

Title: Object Configuration Details

The object configuration details resource is used to view and update the object configuration.

Show Source

• Array of: object userContextObjectTypes-objectConfigs-objectConfigDetails-item-response

{
    "title":"Object Configuration Details",
    "type":"array",
    "description":"The object configuration details resource is used to view and update the object configuration.",
    "items":{
        "$ref":"#/components/schemas/userContextObjectTypes-objectConfigs-objectConfigDetails-item-response"
    }
}

Nested Schema : userContextObjectTypes-objectConfigs-objectConfigDetails-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• DataSourceCode: string
  Title: Data Source Code

  Maximum Length: 30

  The data source code for sources where user context information is captured and stored.
• Enabled: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

  Indicates whether Saved Search is enabled for the user context or not.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumFetchSize: integer (int32)
  Title: Maximum Fetch Size

  Default Value: 5

  Indicates the maximum number of matching objects that can be added to the user context.
• ObjectConfigDetailsId: string
  Title: Object Configuration Details Identifier

  Maximum Length: 512

  The unique identifier of the object configuration detail.
• ObjectTypeCode: string
  Title: Object Type Code

  Maximum Length: 30

  Indicates the code for the type of object.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  Default Value: 1

  The attribute is used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• SavedSearchJson: string (byte)
  Title: Saved Search JSON

  Stores the saved search criteria parameters in JSON format.
• Score: integer (int32)
  Title: Score

  Default Value: 0

  Indicates the base score defined for the Saved Search Criteria.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSourceCode":{
            "title":"Data Source Code",
            "maxLength":30,
            "type":"string",
            "description":"The data source code for sources where user context information is captured and stored.",
            "nullable":true,
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether Saved Search is enabled for the user context or not.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumFetchSize":{
            "title":"Maximum Fetch Size",
            "type":"integer",
            "description":"Indicates the maximum number of matching objects that can be added to the user context.",
            "format":"int32",
            "nullable":false,
            "default":5,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ObjectConfigDetailsId":{
            "title":"Object Configuration Details Identifier",
            "maxLength":512,
            "type":"string",
            "description":"The unique identifier of the object configuration detail.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the code for the type of object.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The attribute is used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SavedSearchJson":{
            "title":"Saved Search JSON",
            "type":"string",
            "description":"Stores the saved search criteria parameters in JSON format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"Indicates the base score defined for the Saved Search Criteria.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : userContextObjectTypes-objectCriteria-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• Enabled: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

  Indicates whether the Saved Search is enabled for user context or not.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumFetchSize: integer (int32)
  Title: Maximum Fetch Size

  Default Value: 5

  The maximum number of matching objects that can be added to the user context.
• ObjectTypeCode: string
  Title: Object Type Code

  Maximum Length: 30

  Specifies the Object type or category that is relevant in a given user context. For example Account, Contact, Lead, and so on.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  Default Value: 1

  The attribute used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• SavedSearchJson: string (byte)
  Title: Saved Search JSON

  The saved search criteria parameters in JSON format.
• SavedSearchUuid: string
  Title: Saved Search GUID

  Maximum Length: 512

  The foreign key reference to the SavedSearchUUID of the Saved Search(zca_es_saved_searches) defined in Workspace.
• Score: integer (int32)
  Title: Score

  Default Value: 0

  The base score defined for the Saved Search Criteria.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the Saved Search is enabled for user context or not.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumFetchSize":{
            "title":"Maximum Fetch Size",
            "type":"integer",
            "description":"The maximum number of matching objects that can be added to the user context.",
            "format":"int32",
            "nullable":false,
            "default":5,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the Object type or category that is relevant in a given user context. For example Account, Contact, Lead, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The attribute used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SavedSearchJson":{
            "title":"Saved Search JSON",
            "type":"string",
            "description":"The saved search criteria parameters in JSON format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SavedSearchUuid":{
            "title":"Saved Search GUID",
            "maxLength":512,
            "type":"string",
            "description":"The foreign key reference to the SavedSearchUUID of the Saved Search(zca_es_saved_searches) defined in Workspace.",
            "nullable":false,
            "x-queryable":true
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"The base score defined for the Saved Search Criteria.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : userContextObjectTypes-relatedObjects-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• Enabled: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

  Indicates whether the related object for the source object is enabled for user context.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The object version number is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• SourceObjectTypeCode: string
  Title: Source Object Type Code

  Maximum Length: 30

  The object type code of the source business object.
• TargetObjectId: string
  Title: Target Object Id

  Maximum Length: 30

  The custom object field mapping used for deriving user context.
• TargetObjectTypeCode: string
  Title: Related Object Type Code

  Maximum Length: 30

  The object type code of the related object. The related object mapping is used for deriving user context.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the related object for the source object is enabled for user context.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SourceObjectTypeCode":{
            "title":"Source Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The object type code of the source business object.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetObjectId":{
            "title":"Target Object Id",
            "maxLength":30,
            "type":"string",
            "description":"The custom object field mapping used for deriving user context.",
            "nullable":true,
            "x-queryable":false
        },
        "TargetObjectTypeCode":{
            "title":"Related Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The object type code of the related object. The related object mapping is used for deriving user context.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

objectConfigs

Operation: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectConfigs

Parameters:

• ObjectTypeCode: $request.path.ObjectTypeCode

The object configurations resource is used to view and update an object configuration.

objectCriteria

Operation: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/objectCriteria

Parameters:

• ObjectTypeCode: $request.path.ObjectTypeCode

The object criteria resource is used to view, create, update, and delete a configuration and mapping. It is used to determine the criteria to query the elastic data store and workspace saved searches.

relatedObjects

Operation: /crmRestApi/resources/11.13.18.05/userContextObjectTypes/{ObjectTypeCode}/child/relatedObjects

Parameters:

• ObjectTypeCode: $request.path.ObjectTypeCode

The related objects resource is used to view and update a related object.

Back to Top

Examples

The following example shows how to get an object type by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/userContextObjectTypes/CRMProduct

Example of Response Body

The following shows the contents of the response body in JSON format.

{
    "ObjectTypeCode": "CRMProduct",
    "Enabled": "Y",
    "CreationDate": "2020-02-29T22:11:03+00:00",
    "CreatedBy": "SEED_DATA_FROM_APPLICATION",
    "LastUpdateDate": "2020-02-29T22:11:03.045+00:00",
    "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
    "LastUpdateLogin": "-1",
    "ObjectVersionNumber": 1,
    
}

Back to Top