Jump to

• Request
• Response

Create an object configuration

post

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

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.

Header Parameters

• 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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DataSourceCode(required): 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.
• 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(required): 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(required): integer (int64)
  Title: Score

  The score of a relevant item.

{
    "required":[
        "DataSourceCode",
        "ObjectTypeCode",
        "Score"
    ],
    "type":"object",
    "properties":{
        "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
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"The score of a relevant item.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"10"
            }
        },
        "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"
            }
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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"
        },
        "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-post-request"
            }
        }
    }
}

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-post-request

{
    "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-post-request"
    }
}

Nested Schema : userContextObjectTypes-objectConfigs-objectConfigDetails-item-post-request

Type: object

Show Source

• 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.
• 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":{
        "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"
            }
        },
        "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
        },
        "ObjectConfigDetailsId":{
            "title":"Object Configuration Details Identifier",
            "maxLength":"512",
            "type":"string",
            "description":"The unique identifier of the object configuration detail.",
            "nullable":false
        },
        "SavedSearchJson":{
            "title":"Saved Search JSON",
            "type":"string",
            "description":"Stores the saved search criteria parameters in JSON format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "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"
            }
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the code for the type of object.",
            "nullable":false
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether Saved Search is enabled for the user context or not.",
            "nullable":false,
            "default":"Y"
        },
        "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"
            }
        }
    }
}

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-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":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated 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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created 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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "Score":{
            "title":"Score",
            "type":"integer",
            "description":"The score of a relevant item.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"10"
            }
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        }
    }
}

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 : 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-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":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated 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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the code for the type of object.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "ObjectConfigDetailsId":{
            "title":"Object Configuration Details Identifier",
            "maxLength":"512",
            "type":"string",
            "description":"The unique identifier of the object configuration detail.",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        }
    }
}

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

objectConfigDetails

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

Parameters:

• DataSourceCode: $request.path.DataSourceCode
• ObjectTypeCode: $request.path.ObjectTypeCode

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

Back to Top