{ "openapi": "3.0.1", "info": { "title": "", "version": "v1" }, "servers": [ { "url": "https://{baseURL}" } ], "paths": { "/api/schema/v1/objects": { "post": { "tags": [ "Object Definition" ], "summary": "Define a new object schema definition", "description": "Validates and creates an object schema definition.", "requestBody": { "description": "Request to create object schema definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectMetadataCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ObjectMetadataCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ObjectMetadataCreateRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectMetadataAPIResponse" }, "example": {"Success":true,"Data":{"Name":"Account","DisplayName":"Account","Description":"Account","IsProtected":true,"IsDeprecated":false,"IsShared":true,"IsDataCacheEnabled":true,"IsTrackingEnabled":true,"Category":"Common","FieldMetadata":[{"FieldName":"Name","DisplayName":"Name","Description":null,"DataType":"String","DefaultValue":null,"IsProtected":false,"IsIndexField":false,"IsSortable":false,"IsRequired":true,"IsUnique":false,"IsDeprecated":false,"IsCalculated":false,"IsAliasField":false,"Length":null,"LookupObjectName":null,"DependentPicklistMetadataName":null,"PicklistName":null,"ComplexMetadataName":null,"AutoNumberInitialSeed":0,"AutoNumberPrefix":null,"Precision":0,"Scale":0,"Expression":null,"ExpressionDependency":null,"AliasExpressionDependency":null,"IsPreComputed":null,"ReferenceObject":null,"TargetObject":null,"TargetField":null,"RollupFunction":null,"RollupFilterCriteria":null,"AliasFieldDefinition":null,"AliasFieldMetadataName":null,"IsRichTextField":false},{"FieldName":"Id","DisplayName":"Id","Description":null,"DataType":"Identifier","DefaultValue":null,"IsProtected":false,"IsIndexField":true,"IsSortable":false,"IsRequired":true,"IsUnique":false,"IsDeprecated":false,"IsCalculated":false,"IsAliasField":false,"Length":null,"LookupObjectName":null,"DependentPicklistMetadataName":null,"PicklistName":null,"ComplexMetadataName":null,"AutoNumberInitialSeed":0,"AutoNumberPrefix":null,"Precision":0,"Scale":0,"Expression":null,"ExpressionDependency":null,"AliasExpressionDependency":null,"IsPreComputed":null,"ReferenceObject":null,"TargetObject":null,"TargetField":null,"RollupFunction":null,"RollupFilterCriteria":null,"AliasFieldDefinition":null,"AliasFieldMetadataName":null,"IsRichTextField":false}],"InternalRuntimeAliasFields":[],"InternalPrecomputedAliasFields":[],"PicklistMetadata":[],"DependentPicklistMetadata":[],"ComplexFieldMetadata":[],"AliasFieldMetadata":[],"CreatedBy":{"Id":"873b8bdf-6a9a-43d7-a47d-1e147a68be41","Name":"System Admin"},"CreatedDate":"2023-09-29T11:30:55.548+00:00","ModifiedBy":{"Id":"ace90bee-d50c-4b8f-992d-6d3f3b8102e7","Name":"System Admin"},"ModifiedDate":"2023-09-29T11:30:55.548+00:00"},"StatusCode":"OK"} } } } } }, "get": { "tags": [ "Object Definition" ], "summary": "List all object names", "description": "Fetches and lists all metadata and returns 'OK' if the request is executed successfully; otherwise, it returns an exception.", "parameters": [ { "name": "sortField", "in": "query", "description": "Field name for sorting", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "description": "Sort direction (Ascending or Descending) of the data based on the sort field.", "schema": { "$ref": "#/components/schemas/SortDirection" } }, { "name": "pageSize", "in": "query", "description": "The number of records to display on each page", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The page number of the result set to view", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectInfoListAPIResponse" }, "example": {"Success":true,"Data":[{"Name":"Currency","DisplayName":"Currency","Description":"Currency","Category":"Platform","IsProtected":true,"IsDeprecated":false},{"Name":"Role","DisplayName":"Role","Description":"Role","Category":"Platform","IsProtected":true,"IsDeprecated":false},{"Name":"ObjectPermission","DisplayName":"ObjectPermission","Description":"ObjectPermission","Category":"Platform","IsProtected":true,"IsDeprecated":false},{"Name":"Agreement_UserShare_p","DisplayName":"Agreement_UserShare_p","Description":"Agreement_UserShare_p","Category":"Platform","IsProtected":true,"IsDeprecated":false}],"StatusCode":"OK"} } } } } } }, "/api/schema/v1/objects/{objectName}": { "put": { "tags": [ "Object Definition" ], "summary": "Update an object schema definition", "description": "Validates and updates an object's schema definition.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Details to be updated in the object's schema definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectMetadataUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ObjectMetadataUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ObjectMetadataUpdateRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectMetadataAPIResponse" }, "example": {"Success":true,"Data":{"Name":"Account","DisplayName":"Account","Description":"Account","IsProtected":true,"IsDeprecated":false,"IsShared":true,"IsDataCacheEnabled":true,"IsTrackingEnabled":true,"Category":"Common","FieldMetadata":[{"FieldName":"Name","DisplayName":"Name","Description":null,"DataType":"String","DefaultValue":null,"IsProtected":false,"IsIndexField":false,"IsSortable":false,"IsRequired":true,"IsUnique":false,"IsDeprecated":false,"IsCalculated":false,"IsAliasField":false,"Length":null,"LookupObjectName":null,"DependentPicklistMetadataName":null,"PicklistName":null,"ComplexMetadataName":null,"AutoNumberInitialSeed":0,"AutoNumberPrefix":null,"Precision":0,"Scale":0,"Expression":null,"ExpressionDependency":null,"AliasExpressionDependency":null,"IsPreComputed":null,"ReferenceObject":null,"TargetObject":null,"TargetField":null,"RollupFunction":null,"RollupFilterCriteria":null,"AliasFieldDefinition":null,"AliasFieldMetadataName":null,"IsRichTextField":false},{"FieldName":"Id","DisplayName":"Id","Description":null,"DataType":"Identifier","DefaultValue":null,"IsProtected":false,"IsIndexField":true,"IsSortable":false,"IsRequired":true,"IsUnique":false,"IsDeprecated":false,"IsCalculated":false,"IsAliasField":false,"Length":null,"LookupObjectName":null,"DependentPicklistMetadataName":null,"PicklistName":null,"ComplexMetadataName":null,"AutoNumberInitialSeed":0,"AutoNumberPrefix":null,"Precision":0,"Scale":0,"Expression":null,"ExpressionDependency":null,"AliasExpressionDependency":null,"IsPreComputed":null,"ReferenceObject":null,"TargetObject":null,"TargetField":null,"RollupFunction":null,"RollupFilterCriteria":null,"AliasFieldDefinition":null,"AliasFieldMetadataName":null,"IsRichTextField":false}],"InternalRuntimeAliasFields":[],"InternalPrecomputedAliasFields":[],"PicklistMetadata":[],"DependentPicklistMetadata":[],"ComplexFieldMetadata":[],"AliasFieldMetadata":[],"CreatedBy":{"Id":"1d7a8ad1-20df-41a8-86f3-70812882e7aa","Name":"System Admin"},"CreatedDate":"2023-09-29T11:30:55.553+00:00","ModifiedBy":{"Id":"bcc4e109-8df4-4c37-993d-d557a4a3b30a","Name":"System Admin"},"ModifiedDate":"2023-09-29T11:30:55.553+00:00"},"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } }, "get": { "tags": [ "Object Definition" ], "summary": "Get an object's schema definition", "description": "Validates and fetches the given object's schema definition.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectMetadataAPIResponse" }, "example": {"Success":true,"Data":{"Name":"Account","DisplayName":"Account","Description":"Account","IsProtected":true,"IsDeprecated":false,"IsShared":true,"IsDataCacheEnabled":true,"IsTrackingEnabled":true,"Category":"Common","FieldMetadata":[{"FieldName":"Name","DisplayName":"Name","Description":null,"DataType":"String","DefaultValue":null,"IsProtected":false,"IsIndexField":false,"IsSortable":false,"IsRequired":true,"IsUnique":false,"IsDeprecated":false,"IsCalculated":false,"IsAliasField":false,"Length":null,"LookupObjectName":null,"DependentPicklistMetadataName":null,"PicklistName":null,"ComplexMetadataName":null,"AutoNumberInitialSeed":0,"AutoNumberPrefix":null,"Precision":0,"Scale":0,"Expression":null,"ExpressionDependency":null,"AliasExpressionDependency":null,"IsPreComputed":null,"ReferenceObject":null,"TargetObject":null,"TargetField":null,"RollupFunction":null,"RollupFilterCriteria":null,"AliasFieldDefinition":null,"AliasFieldMetadataName":null,"IsRichTextField":false},{"FieldName":"Id","DisplayName":"Id","Description":null,"DataType":"Identifier","DefaultValue":null,"IsProtected":false,"IsIndexField":true,"IsSortable":false,"IsRequired":true,"IsUnique":false,"IsDeprecated":false,"IsCalculated":false,"IsAliasField":false,"Length":null,"LookupObjectName":null,"DependentPicklistMetadataName":null,"PicklistName":null,"ComplexMetadataName":null,"AutoNumberInitialSeed":0,"AutoNumberPrefix":null,"Precision":0,"Scale":0,"Expression":null,"ExpressionDependency":null,"AliasExpressionDependency":null,"IsPreComputed":null,"ReferenceObject":null,"TargetObject":null,"TargetField":null,"RollupFunction":null,"RollupFilterCriteria":null,"AliasFieldDefinition":null,"AliasFieldMetadataName":null,"IsRichTextField":false}],"InternalRuntimeAliasFields":[],"InternalPrecomputedAliasFields":[],"PicklistMetadata":[],"DependentPicklistMetadata":[],"ComplexFieldMetadata":[],"AliasFieldMetadata":[],"CreatedBy":{"Id":"2f0ed272-4aad-43e9-b21e-e333bbefdd94","Name":"System Admin"},"CreatedDate":"2023-09-29T11:30:55.554+00:00","ModifiedBy":{"Id":"8dad0221-2484-45eb-9c82-4af3e5eca98a","Name":"System Admin"},"ModifiedDate":"2023-09-29T11:30:55.554+00:00"},"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/shared/{isShared}": { "put": { "tags": [ "Object Definition" ], "summary": "Update the \"IsShared\" field value for a given object", "description": "Sets the **IsShared** field for the given object to indicate whether the object is sharable or not.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object", "required": true, "schema": { "type": "string" } }, { "name": "isShared", "in": "path", "description": "Select the value (True or False)", "required": true, "schema": { "type": "boolean" } } ], "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } } } }, "/api/schema/v1/objects/{objectName}/deprecate": { "patch": { "tags": [ "Object Definition" ], "summary": "Deprecate the object", "description": "Deprecates the object in the metadata. It takes the object name as input and sets it to deprecated.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } } } }, "/api/schema/v1/objects/customschema/import": { "post": { "tags": [ "Object Definition" ], "summary": "Import custom schema", "description": "Imports schema for custom fields and custom objects. \r\n <ul><li><b>For standard object</b>: Creates missing custom fields from the corresponding JSON file (part of the zip file).</li><li><b>For custom object</b>: If a custom object is not available, it is created with all the fields; otherwise, it creates missing custom fields from the corresponding JSON file (part of the zip file).</li></ul>", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringStringDictionaryAPIResponse" } } } } } } }, "/api/schema/v1/objects/{objectName}/fields": { "post": { "tags": [ "Field Definition" ], "summary": "Create a field definition for an object", "description": "Validates and creates a field inside the specified object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object in which the field is to be created", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Actual field metadata input which needs to be created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMetadataCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FieldMetadataCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FieldMetadataCreateRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMetadataAPIResponse" }, "example": {"Success":true,"Data":{"FieldName":"AgreementField","DisplayName":"AgreementField","Description":"AgreementField desc","DataType":"String","DefaultValue":"string","IsProtected":false,"IsIndexField":false,"IsSortable":true,"IsRequired":true,"IsUnique":false,"IsDeprecated":false,"IsCalculated":false,"IsAliasField":false,"Length":200,"LookupObjectName":null,"DependentPicklistMetadataName":null,"PicklistName":null,"ComplexMetadataName":null,"AutoNumberInitialSeed":0,"AutoNumberPrefix":null,"Precision":0,"Scale":0,"Expression":null,"ExpressionDependency":null,"AliasExpressionDependency":null,"IsPreComputed":null,"ReferenceObject":null,"TargetObject":null,"TargetField":null,"RollupFunction":null,"RollupFilterCriteria":null,"AliasFieldDefinition":null,"AliasFieldMetadataName":null,"IsRichTextField":false},"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/fields/{fieldName}": { "put": { "tags": [ "Field Definition" ], "summary": "Update an object's field definition", "description": "Validates and updates the field definitions available in the specified object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object in which the field is to be updated", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "description": "Name of the field to be updated", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Metadata update details for the field mentioned in the field name parameter.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMetadataUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FieldMetadataUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FieldMetadataUpdateRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMetadataAPIResponse" }, "example": {"Success":true,"Data":{"FieldName":"AgreementField","DisplayName":"AgreementField","Description":"AgreementField desc","DataType":"String","DefaultValue":"string","IsProtected":false,"IsIndexField":false,"IsSortable":true,"IsRequired":true,"IsUnique":false,"IsDeprecated":false,"IsCalculated":false,"IsAliasField":false,"Length":200,"LookupObjectName":null,"DependentPicklistMetadataName":null,"PicklistName":null,"ComplexMetadataName":null,"AutoNumberInitialSeed":0,"AutoNumberPrefix":null,"Precision":0,"Scale":0,"Expression":null,"ExpressionDependency":null,"AliasExpressionDependency":null,"IsPreComputed":null,"ReferenceObject":null,"TargetObject":null,"TargetField":null,"RollupFunction":null,"RollupFilterCriteria":null,"AliasFieldDefinition":null,"AliasFieldMetadataName":null,"IsRichTextField":false},"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/fields/{fieldName}/deprecate": { "patch": { "tags": [ "Field Definition" ], "summary": "Set the field to deprecate", "description": "Validates the field of the given object and sets it to be deprecated.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object from which the field is to be deprecated", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "description": "Name of the field to be deprecated", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Field name cannot be empty." }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/fields/{fieldName}/expression/validate": { "post": { "tags": [ "Field Definition" ], "summary": "Validate formula field expression", "description": "Validates the formula field expression of the field of the given object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object in which the field exists", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "description": "Name of the field", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Actual field name, data type, and expression which needs to be validated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormulaFieldExpressionValidationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FormulaFieldExpressionValidationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FormulaFieldExpressionValidationRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/api/schema/v1/objects/formula-functions": { "get": { "tags": [ "Field Definition" ], "summary": "Get the list of formula functions", "description": "Retrives the list of formula funcations from the data storage.", "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/api/schema/v1/objects/{objectName}/indexes": { "post": { "tags": [ "Index Definition" ], "summary": "Index a field", "description": "Validates and enables the \"IsIndexField\" field value to true for a field in a given object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object in which the field exists", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Field name to be indexed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexMetadataCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IndexMetadataCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IndexMetadataCreateRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMetadataAPIResponse" }, "example": {"Success":true,"Data":{"FieldName":"Name","DisplayName":"Name","Description":null,"DataType":"String","DefaultValue":null,"IsProtected":true,"IsIndexField":true,"IsSortable":true,"IsRequired":false,"IsUnique":false,"IsDeprecated":false,"IsCalculated":false,"IsAliasField":false,"Length":2000,"LookupObjectName":null,"DependentPicklistMetadataName":null,"PicklistName":null,"ComplexMetadataName":null,"AutoNumberInitialSeed":0,"AutoNumberPrefix":null,"Precision":0,"Scale":0,"Expression":null,"ExpressionDependency":null,"AliasExpressionDependency":null,"IsPreComputed":null,"ReferenceObject":null,"TargetObject":null,"TargetField":null,"RollupFunction":null,"RollupFilterCriteria":null,"AliasFieldDefinition":null,"AliasFieldMetadataName":null,"IsRichTextField":false},"StatusCode":"Created"} } } }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/indexes/{indexFieldName}": { "delete": { "tags": [ "Index Definition" ], "summary": "Delete an existing index", "description": "Validates and sets the \"IsIndexField\" field value to false for a field in a given object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object in which the field exists", "required": true, "schema": { "type": "string" } }, { "name": "indexFieldName", "in": "path", "description": "Name of the indexed field", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/picklists": { "post": { "tags": [ "Picklist Definition" ], "summary": "Create a new picklist", "description": "Validates and creates a new picklist metadata for the given object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object in which the picklist is to be created", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Input for creating a picklist metadata. <p><b>Note</b>: Each <b>picklist entry</b> must have an unique (incremental) sequence number.</p>", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PicklistMetadataCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PicklistMetadataCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PicklistMetadataCreateRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PicklistMetadataAPIResponse" }, "example": {"Success":true,"Data":{"Name":"TypePickList","AllowNonConfiguredPicklistEntries":false,"PicklistEntries":[{"Value":"Advertisement","DisplayText":"Advertisement","Sequence":0,"IsDeprecated":false},{"Value":"Competitor","DisplayText":"Competitor","Sequence":1,"IsDeprecated":true}],"IsDeprecated":false},"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/picklists/{picklistName}": { "put": { "tags": [ "Picklist Definition" ], "summary": "Update an picklist", "description": "Validates and updates the picklist for the given object and picklist and returns 'OK' if the request is executed successfully; otherwise, it returns an exception.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object in which the picklist is to be updated", "required": true, "schema": { "type": "string" } }, { "name": "picklistName", "in": "path", "description": "Name of the picklist to be updated", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Metadata update details for the picklist mentioned in the picklist name parameter.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PicklistMetadataUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PicklistMetadataUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PicklistMetadataUpdateRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PicklistMetadataAPIResponse" }, "example": {"Success":true,"Data":{"Name":"TypePickList","AllowNonConfiguredPicklistEntries":false,"PicklistEntries":[{"Value":"Analyst","DisplayText":"Analyst","Sequence":0,"IsDeprecated":false},{"Value":"Competitor","DisplayText":"Competitor","Sequence":1,"IsDeprecated":false}],"IsDeprecated":false},"StatusCode":"Created"} } } }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/picklists/{picklistName}/picklist-entries": { "post": { "tags": [ "Picklist Definition" ], "summary": "Create a new picklist entry to a picklist", "description": "Validates and creates a picklist entry for the given picklist and object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object containing the picklist", "required": true, "schema": { "type": "string" } }, { "name": "picklistName", "in": "path", "description": "Name of the picklist in which the entry data is to inserted", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Picklist entry data for the picklist mentioned in the picklist name parameter.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PicklistEntryCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PicklistEntryCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PicklistEntryCreateRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PicklistEntryAPIResponse" }, "example": {"Success":true,"Data":{"Value":"Advertisement","DisplayText":"AdvertisementDisplayText","Sequence":0,"IsDeprecated":false},"StatusCode":"Created"} } } }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/picklists/{picklistName}/picklist-entries/{picklistEntryValue}": { "put": { "tags": [ "Picklist Definition" ], "summary": "Update the picklist entry by picklist entry value", "description": "Validates and updates the picklist value details for the given picklist and object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object containing the picklist", "required": true, "schema": { "type": "string" } }, { "name": "picklistName", "in": "path", "description": "Name of the picklist containing the picklist value", "required": true, "schema": { "type": "string" } }, { "name": "picklistEntryValue", "in": "path", "description": "Name of the picklist value whose data to be updated", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Picklist Value details to be updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PicklistEntryUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PicklistEntryUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PicklistEntryUpdateRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PicklistEntryAPIResponse" }, "example": {"Success":true,"Data":{"Value":"Advertisement","DisplayText":"AdvertisementDisplayText","Sequence":0,"IsDeprecated":true},"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/picklists/{picklistName}/picklist-entries/bulk": { "post": { "tags": [ "Picklist Definition" ], "summary": "Create multiple picklist entries by picklist entry value", "description": "Validates and updates the picklist value details for the given picklist and object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object containing the picklist", "required": true, "schema": { "type": "string" } }, { "name": "picklistName", "in": "path", "description": "Name of the picklist containing the picklist value", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Picklist Value details to be create", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PicklistEntryCreateRequest" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PicklistEntryCreateRequest" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PicklistEntryCreateRequest" } } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PicklistEntryListAPIResponse" }, "example": {"Success":true,"Data":{"Value":"Advertisement","DisplayText":"AdvertisementDisplayText","Sequence":0,"IsDeprecated":false},"StatusCode":"Created"} } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "Picklist Definition" ], "summary": "Update multiple picklist entries by picklist entry value", "description": "Validates and updates the picklist value details for the given picklist and object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object containing the picklist", "required": true, "schema": { "type": "string" } }, { "name": "picklistName", "in": "path", "description": "Name of the picklist containing the picklist value", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Picklist Value details to be updated", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PicklistEntryBulkUpdateRequest" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PicklistEntryBulkUpdateRequest" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PicklistEntryBulkUpdateRequest" } } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PicklistEntryListAPIResponse" }, "example": {"Success":true,"Data":{"Value":"Advertisement","DisplayText":"AdvertisementDisplayText","Sequence":0,"IsDeprecated":true},"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/fields/{fieldName}/dependent-picklists": { "get": { "tags": [ "Dependent Picklist Definition" ], "summary": "Get the dependent picklist", "description": "Validates and fetches the dependent picklist metadata for the given dependent field name and object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object containing the field", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "description": "Name of the dependent field for which the dependent picklist metadata is to be fetched", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentPicklistMetadataAPIResponse" }, "example": {"Success":true,"Data":{"Name":"BillingCity","DependentFieldName":"BillingCity_c","ControllingFieldName":"BillingState_c","ControllingAndDependentPicklistEntries":[{"ControllingPicklistEntry":"Gujarat","DependentPicklistEntries":[{"Value":"Ahmedabad","DisplayText":"Ahmedabad","Sequence":0,"IsDeprecated":false}]}],"IsDeprecated":false},"StatusCode":"Created"} } } } } }, "post": { "tags": [ "Dependent Picklist Definition" ], "summary": "Create a new dependent picklist mapping", "description": "Validates and creates a new dependent picklist mapping for the given dependent field name and object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object containing the fields", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "description": "Name of the dependent field for which the dependent pickist mapping is to be created.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Input for creating a dependent picklist mapping for the controlling and dependent fields.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentPicklistMetadataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DependentPicklistMetadataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DependentPicklistMetadataRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentPicklistMetadataAPIResponse" }, "example": {"Success":true,"Data":{"Name":"BillingCity","DependentFieldName":"BillingCity_c","ControllingFieldName":"BillingState_c","ControllingAndDependentPicklistEntries":[{"ControllingPicklistEntry":"Gujarat","DependentPicklistEntries":[{"Value":"Ahmedabad","DisplayText":"Ahmedabad","Sequence":0,"IsDeprecated":false}]}],"IsDeprecated":false},"StatusCode":"Created"} } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "Dependent Picklist Definition" ], "summary": "Update the dependent picklist", "description": "Validates and updates the dependent picklist metadata for the given dependent field name and object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object containing the field", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "description": "Name of the dependent field for which the dependent picklist metadata is to be updated", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Dependent picklist metadata details to be updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentPicklistMetadataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DependentPicklistMetadataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DependentPicklistMetadataRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentPicklistMetadataAPIResponse" }, "example": {"Success":true,"Data":{"Name":"BillingCity","DependentFieldName":"BillingCity_c","ControllingFieldName":"BillingState_c","ControllingAndDependentPicklistEntries":[{"ControllingPicklistEntry":"Gujarat","DependentPicklistEntries":[{"Value":"Ahmedabad","DisplayText":"Ahmedabad","Sequence":0,"IsDeprecated":false}]}],"IsDeprecated":false},"StatusCode":"Created"} } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "Dependent Picklist Definition" ], "summary": "Delete the dependent picklist", "description": "Validates and removes the dependent picklist metadata for the given dependent field and object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object containing the field", "required": true, "schema": { "type": "string" } }, { "name": "fieldName", "in": "path", "description": "Name of the dependent field from which dependent picklist metadata is to be deleted", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/recordtype-entries": { "post": { "tags": [ "RecordType Definition" ], "summary": "Create a new RecordType picklist entry to a RecordType picklist", "description": "Validates and creates a RecordType picklist entry of RecordType picklist for given object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object containing the picklist", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Picklist entry data for the RecordType.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordTypeEntryCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordTypeEntryCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordTypeEntryCreateRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PicklistEntryAPIResponse" }, "example": {"Success":true,"Data":{"Value":"Advertisement","DisplayText":"AdvertisementDisplayText","Sequence":0,"IsDeprecated":false},"StatusCode":"Created"} } } }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/recordtype-entries/bulk": { "put": { "tags": [ "RecordType Definition" ], "summary": "Update multiple picklist entries of RecordType picklist", "description": "Validates and updates the picklist value details for the RecordType picklist of given object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object containing the picklist", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Picklist Value details to be updated", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordTypeEntryUpdateRequest" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordTypeEntryUpdateRequest" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecordTypeEntryUpdateRequest" } } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PicklistEntryListAPIResponse" }, "example": {"Success":true,"Data":{"Value":"Advertisement","DisplayText":"AdvertisementDisplayText","Sequence":0,"IsDeprecated":true},"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/complex-fields": { "post": { "tags": [ "Complex Field Definition" ], "summary": "Create a new complex field metadata", "description": "Validates and creates metadata for complex fields.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object for which complex fields is to be created.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Complex field metadata details to be created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplexFieldMetadataCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComplexFieldMetadataCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComplexFieldMetadataCreateRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplexFieldMetadataAPIResponse" }, "example": {"Success":true,"Data":{"Name":"DocumentVersionObject","Fields":[{"FieldName":"ObjectId","DisplayName":"ObjectId","Description":null,"DataType":"Lookup","DefaultValue":null,"IsProtected":true,"IsIndexField":false,"IsSortable":false,"IsRequired":false,"IsUnique":false,"IsDeprecated":false,"IsCalculated":false,"IsAliasField":false,"Length":2000,"LookupObjectName":null,"DependentPicklistMetadataName":null,"PicklistName":null,"ComplexMetadataName":null,"AutoNumberInitialSeed":0,"AutoNumberPrefix":null,"Precision":0,"Scale":0,"Expression":null,"ExpressionDependency":null,"AliasExpressionDependency":null,"IsPreComputed":null,"ReferenceObject":null,"TargetObject":null,"TargetField":null,"RollupFunction":null,"RollupFilterCriteria":null,"AliasFieldDefinition":null,"AliasFieldMetadataName":null,"IsRichTextField":false}]},"StatusCode":"Created"} } } }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/complex-field/{complexFieldMetadataName}": { "post": { "tags": [ "Complex Field Definition" ], "summary": "Create a complex field for the given complex field metadata", "description": "Validates and creates a complex field under the given complex field metadata.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object containing the complex field metadata", "required": true, "schema": { "type": "string" } }, { "name": "complexFieldMetadataName", "in": "path", "description": "Name of the complex field metadata into which the complex field is to be entered.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Complex field details to be created in the given complex field metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplexFieldMetadataEntryCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComplexFieldMetadataEntryCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComplexFieldMetadataEntryCreateRequest" } } } }, "responses": { "400": { "description": "Object name cannot be empty." }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMetadataAPIResponse" }, "example": {"Success":true,"Data":{"FieldName":"ComplexField","DisplayName":"ComplexField01","Description":null,"DataType":"Complex","DefaultValue":null,"IsProtected":false,"IsIndexField":false,"IsSortable":false,"IsRequired":false,"IsUnique":false,"IsDeprecated":false,"IsCalculated":false,"IsAliasField":false,"Length":null,"LookupObjectName":null,"DependentPicklistMetadataName":null,"PicklistName":null,"ComplexMetadataName":"ComplexFieldMetadata","AutoNumberInitialSeed":0,"AutoNumberPrefix":null,"Precision":0,"Scale":0,"Expression":null,"ExpressionDependency":null,"AliasExpressionDependency":null,"IsPreComputed":null,"ReferenceObject":null,"TargetObject":null,"TargetField":null,"RollupFunction":null,"RollupFilterCriteria":null,"AliasFieldDefinition":null,"AliasFieldMetadataName":null,"IsRichTextField":false},"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "Complex Field Definition" ], "summary": "Update the complex field definition on an object", "description": "Validates and updates the complex field definition under the given complex field metadata and object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object containing the complex field definition", "required": true, "schema": { "type": "string" } }, { "name": "complexFieldMetadataName", "in": "path", "description": "Name of the complex field metadata in which the complex field definition is to be validated and updated.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Complex field definition update details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplexFieldMetadataEntryUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComplexFieldMetadataEntryUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComplexFieldMetadataEntryUpdateRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMetadataAPIResponse" }, "example": {"Success":true,"Data":{"FieldName":"ComplexField","DisplayName":"ComplexField01","Description":null,"DataType":"Complex","DefaultValue":null,"IsProtected":false,"IsIndexField":false,"IsSortable":false,"IsRequired":false,"IsUnique":false,"IsDeprecated":false,"IsCalculated":false,"IsAliasField":false,"Length":null,"LookupObjectName":null,"DependentPicklistMetadataName":null,"PicklistName":null,"ComplexMetadataName":"ComplexFieldMetadata","AutoNumberInitialSeed":0,"AutoNumberPrefix":null,"Precision":0,"Scale":0,"Expression":null,"ExpressionDependency":null,"AliasExpressionDependency":null,"IsPreComputed":null,"ReferenceObject":null,"TargetObject":null,"TargetField":null,"RollupFunction":null,"RollupFilterCriteria":null,"AliasFieldDefinition":null,"AliasFieldMetadataName":null,"IsRichTextField":false},"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/complex-fields/{complexFieldMetadataName}": { "post": { "tags": [ "Complex Field Definition" ], "summary": "Create complex fields for the given complex field metadata", "description": "Validates and creates multiple complex fields under the given complex field metadata.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object containing the complex field metadata", "required": true, "schema": { "type": "string" } }, { "name": "complexFieldMetadataName", "in": "path", "description": "Name of the complex field metadata into which the complex fields is to be entered.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Complex fields details to be created in the given complex field metadata", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplexFieldMetadataEntryFieldsCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ComplexFieldMetadataEntryFieldsCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ComplexFieldMetadataEntryFieldsCreateRequest" } } } }, "responses": { "400": { "description": "Object name cannot be empty." }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMetadataListAPIResponse" }, "example": {"Success":true,"Data":{"FieldName":"ComplexField","DisplayName":"ComplexField01","Description":null,"DataType":"Complex","DefaultValue":null,"IsProtected":false,"IsIndexField":false,"IsSortable":false,"IsRequired":false,"IsUnique":false,"IsDeprecated":false,"IsCalculated":false,"IsAliasField":false,"Length":null,"LookupObjectName":null,"DependentPicklistMetadataName":null,"PicklistName":null,"ComplexMetadataName":"ComplexFieldMetadata","AutoNumberInitialSeed":0,"AutoNumberPrefix":null,"Precision":0,"Scale":0,"Expression":null,"ExpressionDependency":null,"AliasExpressionDependency":null,"IsPreComputed":null,"ReferenceObject":null,"TargetObject":null,"TargetField":null,"RollupFunction":null,"RollupFilterCriteria":null,"AliasFieldDefinition":null,"AliasFieldMetadataName":null,"IsRichTextField":false},"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } } }, "/api/schema/v1/objects/{objectName}/translations/{locale}": { "post": { "tags": [ "Object Definition Translation" ], "summary": "Define translation for the given object", "description": "Defines translation for the given object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "path", "description": "An identifier for the language and region (for example, en-US) for which you want to define translation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Translation details for the object are to be defined.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectMetadataTranslationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ObjectMetadataTranslationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ObjectMetadataTranslationRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created" } } }, "put": { "tags": [ "Object Definition Translation" ], "summary": "Update translation for the given object", "description": "Updates translation for the given object.", "parameters": [ { "name": "locale", "in": "path", "description": "An identifier for the language and region (for example, en-US) for which you want to update translation.", "required": true, "schema": { "type": "string" } }, { "name": "objectName", "in": "path", "description": "Name of the object", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Translation details for the object are to be updated.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectMetadataTranslation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectMetadataTranslation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectMetadataTranslation" } } } } }, "responses": { "400": { "description": "Invalid Locale Name" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanNullableAPIResponse" }, "example": {"Success":true,"Data":false,"StatusCode":"OK"} } } } } }, "get": { "tags": [ "Object Definition Translation" ], "summary": "Get translation for the given object", "description": "Retrives translation for the given object.", "parameters": [ { "name": "locale", "in": "path", "description": "An identifier for the language and region (for example, en-US) for which you want to retrive translation.", "required": true, "schema": { "type": "string" } }, { "name": "objectName", "in": "path", "description": "Name of the object", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectMetadataTranslationListAPIResponse" }, "example": {"Success":true,"Data":[{"Scope":"Object","Name":"Account_p","DisplayName":"chinese","Description":"协议"},{"Scope":"Field","Name":"AgreementNumber","DisplayName":"协议号","Description":"协议号"},{"Scope":"Picklist","Name":"Request","DisplayName":"要求","Description":null}],"StatusCode":"OK"} } } } } }, "delete": { "tags": [ "Object Definition Translation" ], "summary": "Delete translations for the given object", "parameters": [ { "name": "locale", "in": "path", "description": "An identifier for the language and region (for example, en-US) from which you want to remove translations.", "required": true, "schema": { "type": "string" } }, { "name": "objectName", "in": "path", "description": "Name of the object", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanNullableAPIResponse" }, "example": {"Success":true,"Data":true,"StatusCode":"OK"} } } } } } }, "/api/metadata/v1/objects/{objectName}": { "get": { "tags": [ "Object Metadata" ], "summary": "Get object's schema definition at runtime", "description": "Validates and retrieves an object's metadata.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectMetadataAPIResponse" }, "example": {"Success":true,"Data":{"Name":"Account","DisplayName":"Account","Description":"Account","IsProtected":true,"IsDeprecated":false,"IsShared":true,"IsDataCacheEnabled":true,"IsTrackingEnabled":true,"Category":"Common","FieldMetadata":[{"FieldName":"Name","DisplayName":"Name","Description":null,"DataType":"String","DefaultValue":null,"IsProtected":false,"IsIndexField":false,"IsSortable":false,"IsRequired":true,"IsUnique":false,"IsDeprecated":false,"IsCalculated":false,"IsAliasField":false,"Length":null,"LookupObjectName":null,"DependentPicklistMetadataName":null,"PicklistName":null,"ComplexMetadataName":null,"AutoNumberInitialSeed":0,"AutoNumberPrefix":null,"Precision":0,"Scale":0,"Expression":null,"ExpressionDependency":null,"AliasExpressionDependency":null,"IsPreComputed":null,"ReferenceObject":null,"TargetObject":null,"TargetField":null,"RollupFunction":null,"RollupFilterCriteria":null,"AliasFieldDefinition":null,"AliasFieldMetadataName":null,"IsRichTextField":false},{"FieldName":"Id","DisplayName":"Id","Description":null,"DataType":"Identifier","DefaultValue":null,"IsProtected":false,"IsIndexField":true,"IsSortable":false,"IsRequired":true,"IsUnique":false,"IsDeprecated":false,"IsCalculated":false,"IsAliasField":false,"Length":null,"LookupObjectName":null,"DependentPicklistMetadataName":null,"PicklistName":null,"ComplexMetadataName":null,"AutoNumberInitialSeed":0,"AutoNumberPrefix":null,"Precision":0,"Scale":0,"Expression":null,"ExpressionDependency":null,"AliasExpressionDependency":null,"IsPreComputed":null,"ReferenceObject":null,"TargetObject":null,"TargetField":null,"RollupFunction":null,"RollupFilterCriteria":null,"AliasFieldDefinition":null,"AliasFieldMetadataName":null,"IsRichTextField":false}],"InternalRuntimeAliasFields":[],"InternalPrecomputedAliasFields":[],"PicklistMetadata":[],"DependentPicklistMetadata":[],"ComplexFieldMetadata":[],"AliasFieldMetadata":[],"CreatedBy":{"Id":"8df58270-b6aa-4a5b-9559-041a6e770dfc","Name":"System Admin"},"CreatedDate":"2023-09-29T11:30:55.600+00:00","ModifiedBy":{"Id":"fbd37eab-6b34-4436-bae2-9eaf015a9586","Name":"System Admin"},"ModifiedDate":"2023-09-29T11:30:55.600+00:00"},"StatusCode":"OK"} } } } } } }, "/api/metadata/v1/objects/customschema/export": { "post": { "tags": [ "Object Metadata" ], "summary": "Export custom schema", "description": "For the object(s) passed in the request body, exports a schema (zipped, with a JSON file for each object) for custom fields and custom objects. \r\n <ul><li>All of the custom object, except its default field, is exported.</li><li>All of the standard object, except its default and standard field, is exported.</li></ul>", "requestBody": { "description": "A list of standard and custom objects. **For example**: [\"Agreement\",\"CustomObject1_c\",\"CustomObject2_c\"]", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success" } } } }, "/api/metadata/v1/objects/{objectName}/dependencies": { "get": { "tags": [ "Object Metadata" ], "summary": "Get all dependencies of a given object", "description": "Retrives all dependencies of a given object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object for which dependencies are to be retrieved", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentObjectMetadataListAPIResponse" }, "example": {"Success":true,"Data":[{"Name":"Agreement","FieldName":"ParentAgreement"},{"Name":"AgreementClause","FieldName":"Agreement"}],"StatusCode":"OK"} } } } } } }, "/api/metadata/v1/objects/{objectName}/references": { "get": { "tags": [ "Object Metadata" ], "summary": "Get all references to a given object", "description": "Retrives all references to a given object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the object for which references are to be retrieved", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentObjectMetadataListAPIResponse" }, "example": {"Success":true,"Data":[{"Name":"Agreement","FieldName":"ParentAgreement"},{"Name":"AgreementClause","FieldName":"Agreement"}],"StatusCode":"OK"} } } } } } } }, "components": { "schemas": { "AliasDependencyMetadata": { "type": "object", "properties": { "FieldName": { "type": "string", "nullable": true }, "Dependencies": { "type": "array", "items": { "$ref": "#/components/schemas/AliasFieldDependencyDetail" }, "nullable": true } }, "additionalProperties": false }, "AliasDependencyMetadataAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "$ref": "#/components/schemas/AliasDependencyMetadata" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true }, "Profile": { "type": "string", "nullable": true }, "TotalTime": { "type": "number", "format": "float" }, "StatusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "HasMoreRecords": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "AliasFieldDefinitionDetail": { "type": "object", "properties": { "FieldName": { "type": "string", "nullable": true }, "ObjectName": { "type": "string", "nullable": true }, "Sequence": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AliasFieldDependencyDetail": { "type": "object", "properties": { "ObjectName": { "type": "string", "nullable": true }, "Fields": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AliasFieldMetadata": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "AliasFieldDefinitionDetail": { "type": "array", "items": { "$ref": "#/components/schemas/AliasFieldDefinitionDetail" }, "nullable": true } }, "additionalProperties": false }, "BooleanNullableAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "type": "boolean", "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true }, "Profile": { "type": "string", "nullable": true }, "TotalTime": { "type": "number", "format": "float" }, "StatusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "HasMoreRecords": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ComplexFieldMetadata": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMetadata" }, "nullable": true } }, "additionalProperties": false }, "ComplexFieldMetadataAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "$ref": "#/components/schemas/ComplexFieldMetadata" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true }, "Profile": { "type": "string", "nullable": true }, "TotalTime": { "type": "number", "format": "float" }, "StatusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "HasMoreRecords": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ComplexFieldMetadataCreateRequest": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the complex field metadata", "nullable": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/ComplexFieldMetadataEntryCreateModel" }, "description": "Collection of complex fields", "nullable": true } }, "additionalProperties": false }, "ComplexFieldMetadataEntryCreateModel": { "type": "object", "properties": { "FieldName": { "type": "string", "description": "Name of the complex field", "nullable": true }, "DisplayName": { "type": "string", "description": "Display name of the complex field", "nullable": true }, "Description": { "type": "string", "description": "Description of the complex field", "nullable": true }, "DataType": { "$ref": "#/components/schemas/DataType" }, "IsIndexField": { "type": "boolean", "description": "Indicates if the complex field is indexed." }, "Precision": { "type": "integer", "description": "Precision of the complex field when the data type is Currency, Decimal, or Double.", "format": "int32" }, "Scale": { "type": "integer", "description": "Scale of the complex field when the data type is Currency, Decimal, or Double.", "format": "int32" }, "Length": { "type": "integer", "description": "Length of the complex field when the data type is String or LongString.", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ComplexFieldMetadataEntryCreateRequest": { "type": "object", "properties": { "Field": { "$ref": "#/components/schemas/ComplexFieldMetadataEntryCreateModel" } }, "additionalProperties": false }, "ComplexFieldMetadataEntryFieldsCreateRequest": { "type": "object", "properties": { "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/ComplexFieldMetadataEntryCreateModel" }, "description": "Collection of the Complex Fields", "nullable": true } }, "additionalProperties": false }, "ComplexFieldMetadataEntryUpdateModel": { "type": "object", "properties": { "FieldName": { "type": "string", "description": "Name of the complex field", "nullable": true }, "DisplayName": { "type": "string", "description": "Display name of the complex field", "nullable": true }, "Description": { "type": "string", "description": "Description of the complex field", "nullable": true }, "IsIndexField": { "type": "boolean", "description": "Indicates if the complex field is indexed." }, "Length": { "type": "integer", "description": "Length of the complex field when the data type is String or LongString.", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ComplexFieldMetadataEntryUpdateRequest": { "type": "object", "properties": { "Field": { "$ref": "#/components/schemas/ComplexFieldMetadataEntryUpdateModel" } }, "additionalProperties": false }, "ControllingAndDependentPicklistEntry": { "type": "object", "properties": { "ControllingPicklistEntry": { "type": "string", "nullable": true }, "DependentPicklistEntries": { "type": "array", "items": { "$ref": "#/components/schemas/PicklistEntry" }, "nullable": true } }, "additionalProperties": false }, "ControllingDependentPicklistEntryCreateRequest": { "type": "object", "properties": { "ControllingPicklistEntry": { "type": "string", "description": "Controlling picklist entry of the picklist", "nullable": true }, "DependentPicklistEntries": { "type": "array", "items": { "$ref": "#/components/schemas/PicklistEntryCreateRequest" }, "description": "Collection of the dependent picklist values", "nullable": true } }, "additionalProperties": false, "description": "Controlling dependent picklist entry" }, "DataType": { "enum": [ "String", "Int", "Double", "Currency", "Boolean", "DateTime", "AutoNumber", "Lookup", "Picklist", "MultiPicklist", "Identifier", "LongString", "Complex", "ComplexArray", "Reference", "Rollup", "Decimal", "Image", "Alias" ], "type": "string" }, "DependentObjectMetadata": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "FieldName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DependentObjectMetadataListAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/DependentObjectMetadata" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true }, "Profile": { "type": "string", "nullable": true }, "TotalTime": { "type": "number", "format": "float" }, "StatusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "HasMoreRecords": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "DependentPicklistMetadata": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "DependentFieldName": { "type": "string", "nullable": true }, "ControllingFieldName": { "type": "string", "nullable": true }, "ControllingAndDependentPicklistEntries": { "type": "array", "items": { "$ref": "#/components/schemas/ControllingAndDependentPicklistEntry" }, "nullable": true }, "IsDeprecated": { "type": "boolean" } }, "additionalProperties": false }, "DependentPicklistMetadataAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "$ref": "#/components/schemas/DependentPicklistMetadata" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true }, "Profile": { "type": "string", "nullable": true }, "TotalTime": { "type": "number", "format": "float" }, "StatusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "HasMoreRecords": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "DependentPicklistMetadataRequest": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the dependent picklist", "nullable": true }, "DependentFieldName": { "type": "string", "description": "Dependent field name of the picklist", "nullable": true }, "ControllingFieldName": { "type": "string", "description": "Controlling field name of the picklist", "nullable": true }, "ControllingAndDependentPicklistEntries": { "type": "array", "items": { "$ref": "#/components/schemas/ControllingDependentPicklistEntryCreateRequest" }, "description": "Collection of the controlling and dependent picklist", "nullable": true } }, "additionalProperties": false }, "ErrorDetail": { "type": "object", "properties": { "Message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FieldMetadata": { "type": "object", "properties": { "FieldName": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "DataType": { "$ref": "#/components/schemas/DataType" }, "DefaultValue": { "type": "string", "nullable": true }, "IsProtected": { "type": "boolean" }, "IsIndexField": { "type": "boolean" }, "IsSortable": { "type": "boolean" }, "IsRequired": { "type": "boolean" }, "IsUnique": { "type": "boolean" }, "IsDeprecated": { "type": "boolean" }, "IsCalculated": { "type": "boolean" }, "IsAliasField": { "type": "boolean" }, "Length": { "type": "integer", "format": "int32", "nullable": true }, "LookupObjectName": { "type": "string", "nullable": true }, "DependentPicklistMetadataName": { "type": "string", "nullable": true }, "PicklistName": { "type": "string", "nullable": true }, "ComplexMetadataName": { "type": "string", "nullable": true }, "AutoNumberInitialSeed": { "type": "integer", "format": "int32" }, "AutoNumberPrefix": { "type": "string", "nullable": true }, "Precision": { "type": "integer", "format": "int32" }, "Scale": { "type": "integer", "format": "int32" }, "Expression": { "type": "string", "nullable": true }, "ExpressionDependency": { "type": "array", "items": { "type": "string" }, "nullable": true }, "AliasExpressionDependency": { "type": "array", "items": { "type": "string" }, "nullable": true }, "IsPreComputed": { "type": "boolean", "nullable": true }, "ReferenceObject": { "type": "string", "nullable": true }, "TargetObject": { "type": "string", "nullable": true }, "TargetField": { "type": "string", "nullable": true }, "RollupFunction": { "type": "string", "nullable": true }, "RollupFilterCriteria": { "type": "string", "nullable": true }, "AliasFieldDefinition": { "type": "string", "nullable": true }, "AliasFieldMetadataName": { "type": "string", "nullable": true }, "IsRichTextField": { "type": "boolean" } }, "additionalProperties": false }, "FieldMetadataAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "$ref": "#/components/schemas/FieldMetadata" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true }, "Profile": { "type": "string", "nullable": true }, "TotalTime": { "type": "number", "format": "float" }, "StatusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "HasMoreRecords": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "FieldMetadataCreateRequest": { "type": "object", "properties": { "FieldName": { "type": "string", "description": "Name of the field", "nullable": true }, "DisplayName": { "type": "string", "description": "Display name of the field", "nullable": true }, "Description": { "type": "string", "description": "Description of the field", "nullable": true }, "DataType": { "$ref": "#/components/schemas/DataType" }, "DefaultValue": { "type": "string", "description": "Default value of the field", "nullable": true }, "IsRequired": { "type": "boolean", "description": "Indicates if the field is required." }, "IsSortable": { "type": "boolean", "description": "Indicates if the field is sortable." }, "IsUnique": { "type": "boolean", "description": "Indicates if the field is unique." }, "IsIndexField": { "type": "boolean", "description": "Indicates if the field is indexed." }, "LookupObjectName": { "type": "string", "description": "Lookup object name of the field", "nullable": true }, "PicklistName": { "type": "string", "description": "Picklist name of the field", "nullable": true }, "DependentPicklistMetadataName": { "type": "string", "description": "Dependent picklist metadata name of the field", "nullable": true }, "ComplexMetadataName": { "type": "string", "description": "Complex metadata name of the field", "nullable": true }, "AutoNumberInitialSeed": { "type": "integer", "description": "AutoNumber initial seed value of the field", "format": "int32" }, "AutoNumberPrefix": { "type": "string", "description": "AutoNumber initial seed prefix of the field", "nullable": true }, "Precision": { "type": "integer", "description": "Precision of the field when the data type is Currency, Decimal, or Double.", "format": "int32" }, "Scale": { "type": "integer", "description": "Scale of the field when the data type is Currency, Decimal, or Double.", "format": "int32" }, "IsCalculated": { "type": "boolean", "description": "Indicates if the field is calculated." }, "Expression": { "type": "string", "description": "Describes the expression of the formula field", "nullable": true }, "Length": { "type": "integer", "description": "Length of the field when the data type is String or LongString.", "format": "int32", "nullable": true }, "ReferenceObject": { "type": "string", "description": "Reference object of the field", "nullable": true }, "TargetObject": { "type": "string", "description": "Target object of the field", "nullable": true }, "TargetField": { "type": "string", "description": "Target field of the field", "nullable": true }, "RollupFunction": { "type": "string", "description": "Rollup function of the field", "nullable": true }, "RollupFilterCriteria": { "type": "string", "description": "Rollup filter criteria of the field", "nullable": true }, "IsRichTextField": { "type": "boolean", "description": "Indicates if the field is RichText." }, "AliasFieldDefinition": { "type": "string", "description": "Definition of the alias field", "nullable": true } }, "additionalProperties": false }, "FieldMetadataListAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMetadata" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true }, "Profile": { "type": "string", "nullable": true }, "TotalTime": { "type": "number", "format": "float" }, "StatusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "HasMoreRecords": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "FieldMetadataUpdateRequest": { "type": "object", "properties": { "DisplayName": { "type": "string", "description": "Display name of the field", "nullable": true }, "Description": { "type": "string", "description": "Description of the field", "nullable": true }, "DefaultValue": { "type": "string", "description": "Default value of the field", "nullable": true }, "IsSortable": { "type": "boolean", "description": "Indicates if the field is sortable." }, "IsUnique": { "type": "boolean", "description": "Indicates if the field is unique." }, "Expression": { "type": "string", "description": "Expression of the field", "nullable": true }, "Length": { "type": "integer", "description": "Length of the field when the data type is String or LongString.", "format": "int32", "nullable": true }, "TargetField": { "type": "string", "description": "Target field of the field", "nullable": true }, "RollupFunction": { "type": "string", "description": "Rollup function of the field", "nullable": true }, "RollupFilterCriteria": { "type": "string", "description": "Rollup filter criteria of the field", "nullable": true }, "IsRichTextField": { "type": "boolean", "description": "Indicates if the field is RichText." }, "IsRequired": { "type": "boolean", "description": "Indicates if the field is required." } }, "additionalProperties": false }, "FormulaFieldExpressionValidationRequest": { "type": "object", "properties": { "DataType": { "$ref": "#/components/schemas/DataType" }, "Expression": { "type": "string", "description": "Describes the expression of the formula field", "nullable": true } }, "additionalProperties": false, "description": "formulaFieldExpressionValidationRequest" }, "HttpStatusCode": { "enum": [ "Continue", "SwitchingProtocols", "Processing", "EarlyHints", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultiStatus", "AlreadyReported", "IMUsed", "MultipleChoices", "MovedPermanently", "Found", "SeeOther", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "PermanentRedirect", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "MisdirectedRequest", "UnprocessableEntity", "Locked", "FailedDependency", "UpgradeRequired", "PreconditionRequired", "TooManyRequests", "RequestHeaderFieldsTooLarge", "UnavailableForLegalReasons", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported", "VariantAlsoNegotiates", "InsufficientStorage", "LoopDetected", "NotExtended", "NetworkAuthenticationRequired" ], "type": "string" }, "IndexMetadataCreateRequest": { "type": "object", "properties": { "FieldName": { "type": "string", "description": "Name of the field to be indexed.", "nullable": true } }, "additionalProperties": false }, "LookupObject": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ObjectInfo": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "DisplayName": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "Category": { "type": "string", "nullable": true }, "IsProtected": { "type": "boolean" }, "IsDeprecated": { "type": "boolean" } }, "additionalProperties": false }, "ObjectInfoListAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectInfo" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true }, "Profile": { "type": "string", "nullable": true }, "TotalTime": { "type": "number", "format": "float" }, "StatusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "HasMoreRecords": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ObjectMetadata": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the object to be created", "nullable": true }, "DisplayName": { "type": "string", "description": "Display name of the object", "nullable": true }, "Description": { "type": "string", "description": "Description of the object", "nullable": true }, "IsProtected": { "type": "boolean" }, "IsDeprecated": { "type": "boolean" }, "IsShared": { "type": "boolean" }, "IsDataCacheEnabled": { "type": "boolean", "description": "Indicates if data cache is enabled for this object." }, "IsTrackingEnabled": { "type": "boolean" }, "Category": { "type": "string", "description": "Category of the object", "nullable": true }, "FieldMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMetadata" }, "description": "Collection of the field", "nullable": true }, "InternalRuntimeAliasFields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMetadata" }, "nullable": true }, "InternalPrecomputedAliasFields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMetadata" }, "nullable": true }, "PicklistMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/PicklistMetadata" }, "description": "Collection of the picklist", "nullable": true }, "DependentPicklistMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/DependentPicklistMetadata" }, "description": "Collection of the dependent picklist", "nullable": true }, "ComplexFieldMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/ComplexFieldMetadata" }, "description": "Collection of the complex field", "nullable": true }, "AliasFieldMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/AliasFieldMetadata" }, "nullable": true }, "CreatedBy": { "$ref": "#/components/schemas/LookupObject" }, "CreatedDate": { "type": "string", "format": "date-time" }, "ModifiedBy": { "$ref": "#/components/schemas/LookupObject" }, "ModifiedDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Object's metadata" }, "ObjectMetadataAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "$ref": "#/components/schemas/ObjectMetadata" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true }, "Profile": { "type": "string", "nullable": true }, "TotalTime": { "type": "number", "format": "float" }, "StatusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "HasMoreRecords": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ObjectMetadataCreateRequest": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the object to be created", "nullable": true }, "DisplayName": { "type": "string", "description": "Display name of the object", "nullable": true }, "Description": { "type": "string", "description": "Description of the object", "nullable": true }, "IsDataCacheEnabled": { "type": "boolean", "description": "Indicates if data cache is enabled for this object." }, "Category": { "type": "string", "description": "Category of the object", "nullable": true }, "ComplexFieldMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/ComplexFieldMetadataCreateRequest" }, "description": "Collection of the complex field", "nullable": true }, "FieldMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMetadataCreateRequest" }, "description": "Collection of the field", "nullable": true }, "PicklistMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/PicklistMetadataCreateRequest" }, "description": "Collection of the picklist", "nullable": true }, "DependentPicklistMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/DependentPicklistMetadataRequest" }, "description": "Collection of the dependent picklist", "nullable": true } }, "additionalProperties": false, "description": "Object's metadata create request" }, "ObjectMetadataTranslation": { "type": "object", "properties": { "Scope": { "$ref": "#/components/schemas/TranslationScope" }, "Name": { "type": "string", "description": "Name of the object, field, complex, or picklist as per the translation scope", "nullable": true }, "DisplayName": { "type": "string", "description": "Display name for the translated object, field, complex, or picklist", "nullable": true }, "Description": { "type": "string", "description": "Description for the translated object, field, complex, or picklist", "nullable": true } }, "additionalProperties": false, "description": "Object Metadata translation" }, "ObjectMetadataTranslationListAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectMetadataTranslation" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true }, "Profile": { "type": "string", "nullable": true }, "TotalTime": { "type": "number", "format": "float" }, "StatusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "HasMoreRecords": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ObjectMetadataTranslationRequest": { "type": "object", "properties": { "ObjectName": { "type": "string", "description": "Name of the object requiring translation", "nullable": true }, "MetadataTranslations": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectMetadataTranslation" }, "description": "Collection of translation metadata for a given object", "nullable": true } }, "additionalProperties": false }, "ObjectMetadataUpdateRequest": { "type": "object", "properties": { "DisplayName": { "type": "string", "description": "DisplayName of the Object", "nullable": true }, "Description": { "type": "string", "description": "Description of the Object", "nullable": true }, "IsDataCacheEnabled": { "type": "boolean", "description": "Indicates if DataCache is enabled for this object" }, "IsTrackingEnabled": { "type": "boolean", "description": "Indicates if the Object is TrackingEnabled" }, "Category": { "type": "string", "description": "Category of the Object", "nullable": true } }, "additionalProperties": false }, "PicklistEntry": { "type": "object", "properties": { "Value": { "type": "string", "nullable": true }, "DisplayText": { "type": "string", "nullable": true }, "Sequence": { "type": "integer", "format": "int32" }, "IsDeprecated": { "type": "boolean" } }, "additionalProperties": false }, "PicklistEntryAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "$ref": "#/components/schemas/PicklistEntry" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true }, "Profile": { "type": "string", "nullable": true }, "TotalTime": { "type": "number", "format": "float" }, "StatusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "HasMoreRecords": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "PicklistEntryBulkUpdateRequest": { "type": "object", "properties": { "Value": { "type": "string", "description": "Value of the picklist entry", "nullable": true }, "DisplayText": { "type": "string", "description": "Display text of the picklist entry", "nullable": true }, "Sequence": { "type": "integer", "description": "Sequence of the picklist entry", "format": "int32" }, "IsDeprecated": { "type": "boolean", "description": "Indicates if the picklist entry is deprecated." } }, "additionalProperties": false }, "PicklistEntryCreateRequest": { "type": "object", "properties": { "Value": { "type": "string", "description": "Value of the picklist entry", "nullable": true }, "DisplayText": { "type": "string", "description": "Display text of the picklist entry", "nullable": true }, "Sequence": { "type": "integer", "description": "Sequence of the picklist entry", "format": "int32" } }, "additionalProperties": false }, "PicklistEntryListAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "type": "array", "items": { "$ref": "#/components/schemas/PicklistEntry" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true }, "Profile": { "type": "string", "nullable": true }, "TotalTime": { "type": "number", "format": "float" }, "StatusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "HasMoreRecords": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "PicklistEntryUpdateRequest": { "type": "object", "properties": { "DisplayText": { "type": "string", "description": "Display text of the picklist entry", "nullable": true }, "Sequence": { "type": "integer", "description": "Sequence of the picklist entry", "format": "int32" }, "IsDeprecated": { "type": "boolean", "description": "Indicates if the picklist entry is deprecated." } }, "additionalProperties": false }, "PicklistMetadata": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "AllowNonConfiguredPicklistEntries": { "type": "boolean" }, "PicklistEntries": { "type": "array", "items": { "$ref": "#/components/schemas/PicklistEntry" }, "nullable": true }, "IsDeprecated": { "type": "boolean" } }, "additionalProperties": false }, "PicklistMetadataAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "$ref": "#/components/schemas/PicklistMetadata" }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true }, "Profile": { "type": "string", "nullable": true }, "TotalTime": { "type": "number", "format": "float" }, "StatusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "HasMoreRecords": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "PicklistMetadataCreateRequest": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the picklist", "nullable": true }, "AllowNonConfiguredPicklistEntries": { "type": "boolean", "description": "Indicates whether values other than those defined in the picklist are allowed." }, "PicklistEntries": { "type": "array", "items": { "$ref": "#/components/schemas/PicklistEntryCreateRequest" }, "description": "Colletion of the picklist entries", "nullable": true } }, "additionalProperties": false }, "PicklistMetadataUpdateRequest": { "type": "object", "properties": { "IsDeprecated": { "type": "boolean", "description": "Indicates if the picklist is deprecated." }, "AllowNonConfiguredPicklistEntries": { "type": "boolean", "description": "Indicates whether values other than those defined in the picklist are allowed." } }, "additionalProperties": false }, "RecordTypeEntryCreateRequest": { "type": "object", "properties": { "Value": { "type": "string", "description": "Value of the picklist entry", "nullable": true }, "DisplayText": { "type": "string", "description": "Display text of the picklist entry", "nullable": true }, "Sequence": { "type": "integer", "description": "Sequence of the picklist entry", "format": "int32" } }, "additionalProperties": false }, "RecordTypeEntryUpdateRequest": { "type": "object", "properties": { "Value": { "type": "string", "description": "Value of the picklist entry", "nullable": true }, "DisplayText": { "type": "string", "description": "Display text of the picklist entry", "nullable": true }, "Sequence": { "type": "integer", "description": "Sequence of the picklist entry", "format": "int32" }, "IsDeprecated": { "type": "boolean", "description": "Indicates if the picklist entry is deprecated." } }, "additionalProperties": false }, "SortDirection": { "enum": [ "Ascending", "Descending" ], "type": "string" }, "StringStringDictionaryAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "nullable": true }, "Profile": { "type": "string", "nullable": true }, "TotalTime": { "type": "number", "format": "float" }, "StatusCode": { "$ref": "#/components/schemas/HttpStatusCode" }, "HasMoreRecords": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "TranslationScope": { "enum": [ "Object", "Field", "Complex", "Picklist" ], "type": "string" } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }