Metadata calls are used to facilitate developer access to the application without requiring login to the user interface by providing field names, data types, character limits, etc.
DescribeCvObject
Usage
Use the DescribeCvObject to get metadata associated with your account CvObjects.
General Syntax
DescribeCvObjectResultArray = cventapi.DescribeCvObject (CvObjectTypeArray ObjectTypes)Input
| Name | Type | Description |
|---|---|---|
| ObjectTypes | CvObject Type Array | An array of the objects you want described. |
Output
| Name | Type | Description |
|---|---|---|
| Name | String | Name of the object. This is the same string that was passed in as the CvObjectType parameter. |
| Creatable | Boolean | Indicates whether a Create call can be made (True) or not (False) for this object. |
| Updateable | Boolean | Indicates whether an Update call can be made (True) or not (False) for this object. |
| Deletable | Boolean | Indicates whether a Delete call can be made (True) or not (False) for this object. |
| Replicateable | Boolean | Indicates whether a GetUpdated call can be made (True) or not (False) for this object. |
| Retrieveable | Boolean | Indicates whether a Retrieve call can be made (True) or not (False) for this object. |
| Searchable | Boolean | Indicates whether a Search call can be made (True) or not (False) for this object. |
| Fields | Field | Gives field level data about the object. The field data includes the following information: Name: The field name. DataType: The data type of the field. MaxLength: The maximum length of the field. This property is only used for string type fields. Searchable: Indicates if the field can be used in a Search call. Required: Indicates if the field is required for a Create call. ReadOnly: Indicates if the field can be updated in an Update call or specified in a Create call. DefaultValue: Gives the default value of the field for a Create or Update call, if no value is supplied. DefaultSerachValue: Gives the default value for a Search call if no specific filter for this field is defined. |
| CustomField | Field | Gives field level data about the object. The field data includes the following information: ID: The ID of the custom field. Name: The custom field name. Category: The category of the custom field. FieldType: Indicates the field type. Format: The format of the custom field. SetOrder: The order of the custom field. AnswerText: The answer text of the custom field. |
DescribeGlobal
Usage
Use the DescribeGlobal to get the API settings for your account.
General Syntax
DescribeGlobalResult = cventapi.DescribeGlobal ()Input
This API call takes no input.
Output
| Name | Type | Description |
|---|---|---|
| MaxAPICalls | Integer | Maximum number of API calls that can be made by your organization within a 24-hour period (midnight to midnight) Eastern Time (ET). |
| CurrentAPICalls | Integer | Current number of API calls made by your organization in the current 24-hour period (midnight to midnight) Eastern Time (ET). |
| MaxBatchSize | Integer | The maximum number of records that can be impacted by a Create, Update, or Delete call. |
| MaxRecordSet | Integer | The maximum number of records that can be impacted by a Create, Update, or Delete call. |
| CvObjectTypes | String Array | A list of object types valid for your account. |
Last updated on