Data APIs

{ "openapi": "3.0.1", "info": { "title": "", "version": "v1" }, "servers": [ { "url": "https://{baseURL}" } ], "paths": { "/api/data/v1/custom-objects/{objectName}": { "post": { "tags": [ "Custom Object" ], "summary": "Insert a new record", "description": "Validates the record details and inserts if it does not exist in the given custom object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the custom object in which the record is to be inserted. It can only contain underscores and alphanumeric characters and \"_c\" in the sufix. **For example**: CustomObject_c.", "required": true, "schema": { "type": "string" } }, { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the custom object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", "additionalProperties": { } } } } }, "responses": { "400": { "description": "Found unknown field(s)" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"User doesn't have permission on 'account_p' object."}],"StatusCode":"OK"} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":true,"Data":"abe4830d-af49-4a7e-9b50-9d48eeebda53","StatusCode":"Created"} } } } } }, "get": { "tags": [ "Custom Object" ], "summary": "Get all records", "description": "Returns a list of all records for the given custom object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the custom object from which the records need to be fetched. It can only contain underscores and alphanumeric characters and \"_c\" in the sufix. **For example**: CustomObject_c.", "required": true, "schema": { "type": "string" } }, { "name": "criteria", "in": "query", "description": "Search criteria for the users. **For example**: IsActive = 'true'. **Note**: The criteria field (in this case, IsActive) should be indexed.", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records in each page. **For example**: 5, It will display 5 records on each page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Number of pages to be fetched. **For example**: 2, It will fetch the second page with the number of records (mentioned in the pageSize parameter).**Note**:The page Index starts from 1.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortField", "in": "query", "description": "Field name for sorting. **For example**: FirstName. **Note**: The sort field (in this case, FirstName) should be indexed or sortable.", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "description": "Sort direction for the data.", "schema": { "$ref": "#/components/schemas/SortDirection" } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryListAPIResponse" }, "example": {"Success":true,"RecordCount":1,"Data":[{"Name":"System Admin","Id":"9ba2e887-722c-4d6a-a558-647442609aad"}],"StatusCode":"OK"} } } } } } }, "/api/data/v1/custom-objects/{objectName}/{id}": { "get": { "tags": [ "Custom Object" ], "summary": "Get a record using record ID", "description": "Checks the record ID in the given custom bject and fetches the record if it exists.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the custom object. It can only contain underscores and alphanumeric characters and \"_c\" in the sufix. **For example**: CustomObject_c.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Actual record ID. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" }, "404": { "description": "Record not found" } } }, "put": { "tags": [ "Custom Object" ], "summary": "Update a record", "description": "Updates the record based on the custom object, record ID, and the details of the record that you want to update.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the custom object. It can only contain underscores and alphanumeric characters and \"_c\" in the sufix. **For example**: CustomObject_c.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Actual record ID. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "required": true, "schema": { "type": "string" } }, { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } }, { "name": "EnforceOptimisticLocking", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the custom object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", "additionalProperties": { } } }, "application/*+json": { "schema": { "type": "object", "additionalProperties": { } } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryAPIResponse" }, "example": {"Success":true,"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "Custom Object" ], "summary": "Delete a record", "description": "Validates the record based on the record ID and removes it from the given custom object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the custom object. It can only contain underscores and alphanumeric characters and \"_c\" in the sufix. **For example**: CustomObject_c.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "Actual record ID. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanNullableAPIResponse" }, "example": {"Success":true,"Data":true,"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } } }, "/api/data/v1/custom-objects/{objectName}/bulk": { "post": { "tags": [ "Custom Object" ], "summary": "Insert multiple records", "description": "Validates the custom object record details and creates multiple records in the given custom object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the custom object in which the record is to be inserted. It can only contain underscores and alphanumeric characters and \"_c\" in the sufix. **For example**: CustomObject_c.", "required": true, "schema": { "type": "string" } }, { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the custom object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } }, "text/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListAPIResponse" }, "example": {"Success":true,"Data":["3176f955-8ba3-40fc-88cd-89837b2b25dd","c8fb3f47-6694-4d24-ae2e-f626254306d5","e31c406d-7530-42a4-9b38-eb5076e7aeda"],"StatusCode":"Created"} } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "Custom Object" ], "summary": "Update multiple records", "description": "Validates the custom object record details and updates multiple records in the given custom object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the custom object in which the record is to be updated. It can only contain underscores and alphanumeric characters and \"_c\" in the sufix. **For example**: CustomObject_c.", "required": true, "schema": { "type": "string" } }, { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } }, { "name": "EnforceOptimisticLocking", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the custom object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } }, "text/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" } } }, "delete": { "tags": [ "Custom Object" ], "summary": "Delete multiple records", "description": "Removes multiple records from the given custom object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the custom object. It can only contain underscores and alphanumeric characters and \"_c\" in the sufix. **For example**: CustomObject_c.", "required": true, "schema": { "type": "string" } }, { "name": "IncludeDeleteResultStatus", "in": "query", "description": "Set to true to get the delete status in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Multiple record IDs to be deleted. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "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" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":true,"Data":"DeletedRecordIds : [57eab8d2-2696-4bfa-98f5-d2e0da2604b4,ee001494-c278-477b-ad68-e2364afbe0c0]","StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "Custom Object" ], "summary": "Upsert multiple records", "description": "Validates the record details and updates if id exists else inserts if it does not exist in the given custom object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the custom object in which the record is to be inserted. It can only contain underscores and alphanumeric characters and \"_c\" in the sufix. **For example**: CustomObject_c.", "required": true, "schema": { "type": "string" } }, { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } }, { "name": "EnforceOptimisticLocking", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the custom object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } }, "text/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" } } } }, "/api/data/v1/custom-objects/{objectName}/criteria/bulk": { "put": { "tags": [ "Custom Object" ], "summary": "Update multiple records by criteria", "description": "Validates the custom object record details and updates multiple records that satisfy the criteria.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the custom object in which the record is to be updated. It can only contain underscores and alphanumeric characters and \"_c\" in the sufix. **For example**: CustomObject_c.", "required": true, "schema": { "type": "string" } }, { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } }, { "name": "EnforceOptimisticLocking", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Criteria based request for bulk updating records.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateManyByCriteriaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateManyByCriteriaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateManyByCriteriaRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" } } }, "delete": { "tags": [ "Custom Object" ], "summary": "Delete multiple records using criteria", "description": "Removes multiple records that satisfy the criteria in the custom object.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the custom object from which records are to be removed. It can only contain underscores and alphanumeric characters and \"_c\" in the sufix. **For example**: CustomObject_c.", "required": true, "schema": { "type": "string" } }, { "name": "IncludeDeleteResultStatus", "in": "query", "description": "Set to true to get the delete status in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteByCriteriaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteByCriteriaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteByCriteriaRequest" } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } } } } }, "/api/data/v1/custom-objects/query/parallel": { "post": { "tags": [ "Custom Object" ], "summary": "Execute multiple queries", "description": "Executes multiple query requests parallelly on custom objects and returns the responses of each query in a list.", "requestBody": { "description": "Array of query request", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Query" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Query" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Query" } } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryListListAPIResponse" }, "example": {"Success":true,"Data":[[{"Name":"System Admin","Id":"c252bf97-ba29-4232-8fb2-21af333e88ba"}],[{"Name":"Limited Access User","Id":"3d63d08a-9c99-48ba-82fb-466e04939bcc"}]],"StatusCode":"OK"} } } } } } }, "/api/data/v1/custom-objects/query/{objectName}": { "post": { "tags": [ "Custom Object" ], "summary": "Execute single query", "description": "Validates and executes the query request for the given custom object and specifying whether the total record count should be included in the response.", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the custom object to which query needs to be processed.It can only contain underscores and alphanumeric characters and \"_c\" in the sufix. **For example**: CustomObject_c.", "required": true, "schema": { "type": "string" } }, { "name": "IncludeTotalCount", "in": "query", "description": "Set to true to get the total count of records in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Actual query to be executed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Query" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Query" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Query" } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryListAPIResponse" }, "example": {"Success":true,"RecordCount":1,"Data":[{"Name":"System Admin","Id":"5de96e38-97d7-47db-a700-9caaf169dd3e"}],"StatusCode":"OK"} } } } } } }, "/api/data/v1/custom-objects/{objectName}/recordtypes": { "get": { "tags": [ "Custom Object" ], "summary": "Get List of RecordType for Custom Object", "parameters": [ { "name": "objectName", "in": "path", "description": "Name of the custom object for which need to fetch recordtype. It can only contain underscores and alphanumeric characters and \"_c\" in the sufix. **For example**: CustomObject_c.", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" }, "404": { "description": "Record not found" } } } }, "/api/data/v1/Account": { "post": { "tags": [ "Account" ], "summary": "Insert a new account record", "description": "Validates the record details and inserts if it does not exist in the given object.", "parameters": [ { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountRequestExample" }, "example": "{\"Name\":\"Conga Account\",\"AccountNumber\":\"1111111111\",\"AccountSource\":\"Account Source\",\"BillingAddress\":\"Billing Address\",\"BillingCity\":\"Billing City\",\"ChannelProgramName\":\"Channel Program Name\",\"Industry\":\"Communications\",\"IsCustomerPortal\":\"false\",\"IsPartner\":true,\"AnnualRevenue\":111111,\"BillingCountry\":\"Billing Country\",\"BillingCountryCode\":\"Billing Country Code\",\"BillingPostalCode\":\"Billing Postal Code\",\"BillingState\":\"Billing State\",\"BillingStreet\":\"Billing Street\",\"ChannelProgramLevelName\":\"Channel ProgramLevel Name\",\"Description\":\"Description\",\"Fax\":\"Fax\",\"Owner\":{\"Id\":\"Guid\",\"Name\":\"User Name\"},\"Ownership\":\"Public\",\"Parent\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Phone\":\"111111111\",\"PhotoUrl\":\"https://testurl.com/1234\",\"Rating\":\"Rating\",\"ShippingAddress\":\"Shipping Address\",\"ShippingCity\":\"Shipping City\",\"ShippingCountry\":\"Shipping Country\",\"ShippingCountryCode\":\"Shipping Country Code\",\"ShippingPostalCode\":\"Shipping Postal Code\",\"ShippingState\":\"Shipping State\",\"ShippingStreet\":\"Shipping Street\",\"Site\":\"Site\",\"Type\":\"Type\",\"Website\":\"https://testweb.com\",\"PriceList\":{\"Id\":\"Guid\",\"Name\":\"PriceList Name\"}}" } } }, "responses": { "400": { "description": "Found unknown field(s)" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"User doesn't have permission on 'account_p' object."}],"StatusCode":"OK"} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":true,"Data":"65439574-b38d-4dd2-9a81-c3b8ead11469","StatusCode":"Created"} } } } } }, "get": { "tags": [ "Account" ], "summary": "Get all account records", "description": "Returns a list of all records for the given object.", "parameters": [ { "name": "criteria", "in": "query", "description": "Search criteria for the users. **For example**: IsActive = 'true'. **Note**: The criteria field (in this case, IsActive) should be indexed.", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records in each page. **For example**: 5, It will display 5 records on each page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Number of pages to be fetched. **For example**: 2, It will fetch the second page with the number of records (mentioned in the pageSize parameter).**Note**:The page Index starts from 1.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortField", "in": "query", "description": "Field name for sorting. **For example**: FirstName. **Note**: The sort field (in this case, FirstName) should be indexed or sortable.", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "description": "Sort direction for the data.", "schema": { "$ref": "#/components/schemas/SortDirection" } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryListAPIResponse" }, "example": {"Success":true,"RecordCount":1,"Data":[{"Name":"System Admin","Id":"85530710-0347-4284-ab18-ab4ca988ce09"}],"StatusCode":"OK"} } } } } } }, "/api/data/v1/Account/{id}": { "get": { "tags": [ "Account" ], "summary": "Get a account record using account record ID", "description": "Checks the record ID in the given object and fetches the record if it exists.", "parameters": [ { "name": "id", "in": "path", "description": "Actual record ID. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" }, "404": { "description": "Record not found" } } }, "put": { "tags": [ "Account" ], "summary": "Update a account record", "description": "Updates the record based on the object, record ID, and the details of the record that you want to update.", "parameters": [ { "name": "id", "in": "path", "description": "Actual record ID. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "required": true, "schema": { "type": "string" } }, { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } }, { "name": "EnforceOptimisticLocking", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountRequestExample" }, "example": "{\"Name\":\"Conga Account\",\"AccountNumber\":\"1111111111\",\"AccountSource\":\"Account Source\",\"BillingAddress\":\"Billing Address\",\"BillingCity\":\"Billing City\",\"ChannelProgramName\":\"Channel Program Name\",\"Industry\":\"Communications\",\"IsCustomerPortal\":\"false\",\"IsPartner\":true,\"AnnualRevenue\":111111,\"BillingCountry\":\"Billing Country\",\"BillingCountryCode\":\"Billing Country Code\",\"BillingPostalCode\":\"Billing Postal Code\",\"BillingState\":\"Billing State\",\"BillingStreet\":\"Billing Street\",\"ChannelProgramLevelName\":\"Channel ProgramLevel Name\",\"Description\":\"Description\",\"Fax\":\"Fax\",\"Owner\":{\"Id\":\"Guid\",\"Name\":\"User Name\"},\"Ownership\":\"Public\",\"Parent\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Phone\":\"111111111\",\"PhotoUrl\":\"https://testurl.com/1234\",\"Rating\":\"Rating\",\"ShippingAddress\":\"Shipping Address\",\"ShippingCity\":\"Shipping City\",\"ShippingCountry\":\"Shipping Country\",\"ShippingCountryCode\":\"Shipping Country Code\",\"ShippingPostalCode\":\"Shipping Postal Code\",\"ShippingState\":\"Shipping State\",\"ShippingStreet\":\"Shipping Street\",\"Site\":\"Site\",\"Type\":\"Type\",\"Website\":\"https://testweb.com\",\"PriceList\":{\"Id\":\"Guid\",\"Name\":\"PriceList Name\"}}" } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryAPIResponse" }, "example": {"Success":true,"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "Account" ], "summary": "Delete a account record", "description": "Validates the record based on the record ID and removes it from the given object.", "parameters": [ { "name": "id", "in": "path", "description": "Actual record ID. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanNullableAPIResponse" }, "example": {"Success":true,"Data":true,"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } } }, "/api/data/v1/Account/bulk": { "post": { "tags": [ "Account" ], "summary": "Insert multiple account records", "description": "Validates the object record details and creates multiple records in the given object.", "parameters": [ { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountRequestExample" }, "example": "[{\"Name\":\"Conga Account\",\"AccountNumber\":\"1111111111\",\"AccountSource\":\"Account Source\",\"BillingAddress\":\"Billing Address\",\"BillingCity\":\"Billing City\",\"ChannelProgramName\":\"Channel Program Name\",\"Industry\":\"Communications\",\"IsCustomerPortal\":\"false\",\"IsPartner\":true,\"AnnualRevenue\":111111,\"BillingCountry\":\"Billing Country\",\"BillingCountryCode\":\"Billing Country Code\",\"BillingPostalCode\":\"Billing Postal Code\",\"BillingState\":\"Billing State\",\"BillingStreet\":\"Billing Street\",\"ChannelProgramLevelName\":\"Channel ProgramLevel Name\",\"Description\":\"Description\",\"Fax\":\"Fax\",\"Owner\":{\"Id\":\"Guid\",\"Name\":\"User Name\"},\"Ownership\":\"Public\",\"Parent\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Phone\":\"111111111\",\"PhotoUrl\":\"https://testurl.com/1234\",\"Rating\":\"Rating\",\"ShippingAddress\":\"Shipping Address\",\"ShippingCity\":\"Shipping City\",\"ShippingCountry\":\"Shipping Country\",\"ShippingCountryCode\":\"Shipping Country Code\",\"ShippingPostalCode\":\"Shipping Postal Code\",\"ShippingState\":\"Shipping State\",\"ShippingStreet\":\"Shipping Street\",\"Site\":\"Site\",\"Type\":\"Type\",\"Website\":\"https://testweb.com\",\"PriceList\":{\"Id\":\"Guid\",\"Name\":\"PriceList Name\"}},{\"Name\":\"Conga Account\",\"AccountNumber\":\"1111111111\",\"AccountSource\":\"Account Source\",\"BillingAddress\":\"Billing Address\",\"BillingCity\":\"Billing City\",\"ChannelProgramName\":\"Channel Program Name\",\"Industry\":\"Communications\",\"IsCustomerPortal\":\"false\",\"IsPartner\":true,\"AnnualRevenue\":111111,\"BillingCountry\":\"Billing Country\",\"BillingCountryCode\":\"Billing Country Code\",\"BillingPostalCode\":\"Billing Postal Code\",\"BillingState\":\"Billing State\",\"BillingStreet\":\"Billing Street\",\"ChannelProgramLevelName\":\"Channel ProgramLevel Name\",\"Description\":\"Description\",\"Fax\":\"Fax\",\"Owner\":{\"Id\":\"Guid\",\"Name\":\"User Name\"},\"Ownership\":\"Public\",\"Parent\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Phone\":\"111111111\",\"PhotoUrl\":\"https://testurl.com/1234\",\"Rating\":\"Rating\",\"ShippingAddress\":\"Shipping Address\",\"ShippingCity\":\"Shipping City\",\"ShippingCountry\":\"Shipping Country\",\"ShippingCountryCode\":\"Shipping Country Code\",\"ShippingPostalCode\":\"Shipping Postal Code\",\"ShippingState\":\"Shipping State\",\"ShippingStreet\":\"Shipping Street\",\"Site\":\"Site\",\"Type\":\"Type\",\"Website\":\"https://testweb.com\",\"PriceList\":{\"Id\":\"Guid\",\"Name\":\"PriceList Name\"}}]" } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListAPIResponse" }, "example": {"Success":true,"Data":["36a6a3b2-d0e1-4689-a74f-330230dc941d","cac38445-068d-42ff-8065-b69fe16ba66b","780cdb79-9ece-430a-a843-c561293995d0"],"StatusCode":"Created"} } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "Account" ], "summary": "Update multiple account records", "description": "Validates the object record details and updates multiple records in the given object.", "parameters": [ { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } }, { "name": "EnforceOptimisticLocking", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountRequestExample" }, "example": "[{\"Name\":\"Conga Account\",\"AccountNumber\":\"1111111111\",\"AccountSource\":\"Account Source\",\"BillingAddress\":\"Billing Address\",\"BillingCity\":\"Billing City\",\"ChannelProgramName\":\"Channel Program Name\",\"Industry\":\"Communications\",\"IsCustomerPortal\":\"false\",\"IsPartner\":true,\"AnnualRevenue\":111111,\"BillingCountry\":\"Billing Country\",\"BillingCountryCode\":\"Billing Country Code\",\"BillingPostalCode\":\"Billing Postal Code\",\"BillingState\":\"Billing State\",\"BillingStreet\":\"Billing Street\",\"ChannelProgramLevelName\":\"Channel ProgramLevel Name\",\"Description\":\"Description\",\"Fax\":\"Fax\",\"Owner\":{\"Id\":\"Guid\",\"Name\":\"User Name\"},\"Ownership\":\"Public\",\"Parent\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Phone\":\"111111111\",\"PhotoUrl\":\"https://testurl.com/1234\",\"Rating\":\"Rating\",\"ShippingAddress\":\"Shipping Address\",\"ShippingCity\":\"Shipping City\",\"ShippingCountry\":\"Shipping Country\",\"ShippingCountryCode\":\"Shipping Country Code\",\"ShippingPostalCode\":\"Shipping Postal Code\",\"ShippingState\":\"Shipping State\",\"ShippingStreet\":\"Shipping Street\",\"Site\":\"Site\",\"Type\":\"Type\",\"Website\":\"https://testweb.com\",\"PriceList\":{\"Id\":\"Guid\",\"Name\":\"PriceList Name\"}},{\"Name\":\"Conga Account\",\"AccountNumber\":\"1111111111\",\"AccountSource\":\"Account Source\",\"BillingAddress\":\"Billing Address\",\"BillingCity\":\"Billing City\",\"ChannelProgramName\":\"Channel Program Name\",\"Industry\":\"Communications\",\"IsCustomerPortal\":\"false\",\"IsPartner\":true,\"AnnualRevenue\":111111,\"BillingCountry\":\"Billing Country\",\"BillingCountryCode\":\"Billing Country Code\",\"BillingPostalCode\":\"Billing Postal Code\",\"BillingState\":\"Billing State\",\"BillingStreet\":\"Billing Street\",\"ChannelProgramLevelName\":\"Channel ProgramLevel Name\",\"Description\":\"Description\",\"Fax\":\"Fax\",\"Owner\":{\"Id\":\"Guid\",\"Name\":\"User Name\"},\"Ownership\":\"Public\",\"Parent\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Phone\":\"111111111\",\"PhotoUrl\":\"https://testurl.com/1234\",\"Rating\":\"Rating\",\"ShippingAddress\":\"Shipping Address\",\"ShippingCity\":\"Shipping City\",\"ShippingCountry\":\"Shipping Country\",\"ShippingCountryCode\":\"Shipping Country Code\",\"ShippingPostalCode\":\"Shipping Postal Code\",\"ShippingState\":\"Shipping State\",\"ShippingStreet\":\"Shipping Street\",\"Site\":\"Site\",\"Type\":\"Type\",\"Website\":\"https://testweb.com\",\"PriceList\":{\"Id\":\"Guid\",\"Name\":\"PriceList Name\"}}]" } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" } } }, "delete": { "tags": [ "Account" ], "summary": "Delete multiple account records", "description": "Removes multiple records from the given object.", "parameters": [ { "name": "IncludeDeleteResultStatus", "in": "query", "description": "Set to true to get the delete status in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Multiple record IDs to be deleted. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "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" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":true,"Data":"DeletedRecordIds : [8d9eaedc-f380-4f57-831f-45cf9cdc5c2d,f9d71b3f-a0d3-4354-800f-76933308db3d]","StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "Account" ], "summary": "Upsert multiple account records", "description": "Validates the record details and updates if id exists else inserts if it does not exist in the given object.", "parameters": [ { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } }, { "name": "EnforceOptimisticLocking", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } }, "text/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" } } } }, "/api/data/v1/Account/query": { "post": { "tags": [ "Account" ], "summary": "Execute single query", "description": "Validates and executes the query request for the given object and specifying whether the total record count should be included in the response.", "parameters": [ { "name": "IncludeTotalCount", "in": "query", "description": "Set to true to get the total count of records in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Actual query to be executed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Query" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Query" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Query" } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryListAPIResponse" }, "example": {"Success":true,"RecordCount":1,"Data":[{"Name":"System Admin","Id":"1136f38e-0ea4-4186-9b7f-f04eaeb3368a"}],"StatusCode":"OK"} } } } } } }, "/api/data/v1/Account/recordtypes": { "get": { "tags": [ "Account" ], "summary": "Get List of RecordType", "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" }, "404": { "description": "Record not found" } } } }, "/api/data/v1/Contact": { "post": { "tags": [ "Contact" ], "summary": "Insert a new contact record", "description": "Validates the record details and inserts if it does not exist in the given object.", "parameters": [ { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequestExample" }, "example": "{\"Account\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Name\":\"Contact Name\",\"FirstName\":\"Contact First Name\",\"LastName\":\"Contact Last Name\",\"AssistantName\":\"Assistant Name\",\"Department\":\"QA\",\"Description\":\"Sample Contact Rec\",\"DoNotCall\":\"false\",\"Email\":\"test@email.com\",\"IsEmailBounced\":true,\"EmailBouncedDate\":\"2021-02-25\",\"EmailBouncedReason\":\"Failure\",\"LeadSource\":\"Lead Source\",\"AssistantPhone\":\"1111111111\",\"Birthdate\":\"2021-02-25\",\"Fax\":\"TestFAX\",\"HasOptedOutOfEmail\":\"false\",\"HasOptedOutOfFax\":\"false\",\"HomePhone\":\"1111111111\",\"MailingAddress\":\"Mailing Address\",\"MailingCity\":\"Mailing City\",\"MailingCountry\":\"Mailing Country\",\"MailingCountryCode\":\"Mailing Country Code\",\"MailingPostalCode\":\"Mailing Postal Code\",\"MailingState\":\"Mailing State\",\"MailingStreet\":\"Mailing Street\",\"MobilePhone\":\"1111111111\",\"OtherAddress\":\"Other Address\",\"OtherCity\":\"Other City\",\"OtherCountry\":\"Other Country\",\"OtherCountryCode\":\"Other Country Code\",\"OtherPhone\":\"1111111111\",\"OtherPostalCode\":\"Other Postal Code\",\"OtherState\":\"Other State\",\"OtherStreet\":\"Other Street\",\"Owner\":{\"Id\":\"Guid\",\"Name\":\"User Name\"},\"Phone\":\"1111111111\",\"PhotoUrl\":\"https://test.com/123\",\"Salutation\":\"Salutation\",\"Title\":\"Title\"}" } } }, "responses": { "400": { "description": "Found unknown field(s)" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"User doesn't have permission on 'account_p' object."}],"StatusCode":"OK"} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":true,"Data":"65439574-b38d-4dd2-9a81-c3b8ead11469","StatusCode":"Created"} } } } } }, "get": { "tags": [ "Contact" ], "summary": "Get all contact records", "description": "Returns a list of all records for the given object.", "parameters": [ { "name": "criteria", "in": "query", "description": "Search criteria for the users. **For example**: IsActive = 'true'. **Note**: The criteria field (in this case, IsActive) should be indexed.", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records in each page. **For example**: 5, It will display 5 records on each page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Number of pages to be fetched. **For example**: 2, It will fetch the second page with the number of records (mentioned in the pageSize parameter).**Note**:The page Index starts from 1.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortField", "in": "query", "description": "Field name for sorting. **For example**: FirstName. **Note**: The sort field (in this case, FirstName) should be indexed or sortable.", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "description": "Sort direction for the data.", "schema": { "$ref": "#/components/schemas/SortDirection" } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryListAPIResponse" }, "example": {"Success":true,"RecordCount":1,"Data":[{"Name":"System Admin","Id":"85530710-0347-4284-ab18-ab4ca988ce09"}],"StatusCode":"OK"} } } } } } }, "/api/data/v1/Contact/{id}": { "get": { "tags": [ "Contact" ], "summary": "Get a contact record using contact record ID", "description": "Checks the record ID in the given object and fetches the record if it exists.", "parameters": [ { "name": "id", "in": "path", "description": "Actual record ID. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" }, "404": { "description": "Record not found" } } }, "put": { "tags": [ "Contact" ], "summary": "Update a contact record", "description": "Updates the record based on the object, record ID, and the details of the record that you want to update.", "parameters": [ { "name": "id", "in": "path", "description": "Actual record ID. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "required": true, "schema": { "type": "string" } }, { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } }, { "name": "EnforceOptimisticLocking", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequestExample" }, "example": "{\"Account\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Name\":\"Contact Name\",\"FirstName\":\"Contact First Name\",\"LastName\":\"Contact Last Name\",\"AssistantName\":\"Assistant Name\",\"Department\":\"QA\",\"Description\":\"Sample Contact Rec\",\"DoNotCall\":\"false\",\"Email\":\"test@email.com\",\"IsEmailBounced\":true,\"EmailBouncedDate\":\"2021-02-25\",\"EmailBouncedReason\":\"Failure\",\"LeadSource\":\"Lead Source\",\"AssistantPhone\":\"1111111111\",\"Birthdate\":\"2021-02-25\",\"Fax\":\"TestFAX\",\"HasOptedOutOfEmail\":\"false\",\"HasOptedOutOfFax\":\"false\",\"HomePhone\":\"1111111111\",\"MailingAddress\":\"Mailing Address\",\"MailingCity\":\"Mailing City\",\"MailingCountry\":\"Mailing Country\",\"MailingCountryCode\":\"Mailing Country Code\",\"MailingPostalCode\":\"Mailing Postal Code\",\"MailingState\":\"Mailing State\",\"MailingStreet\":\"Mailing Street\",\"MobilePhone\":\"1111111111\",\"OtherAddress\":\"Other Address\",\"OtherCity\":\"Other City\",\"OtherCountry\":\"Other Country\",\"OtherCountryCode\":\"Other Country Code\",\"OtherPhone\":\"1111111111\",\"OtherPostalCode\":\"Other Postal Code\",\"OtherState\":\"Other State\",\"OtherStreet\":\"Other Street\",\"Owner\":{\"Id\":\"Guid\",\"Name\":\"User Name\"},\"Phone\":\"1111111111\",\"PhotoUrl\":\"https://test.com/123\",\"Salutation\":\"Salutation\",\"Title\":\"Title\"}" } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryAPIResponse" }, "example": {"Success":true,"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "Contact" ], "summary": "Delete a contact record", "description": "Validates the record based on the record ID and removes it from the given object.", "parameters": [ { "name": "id", "in": "path", "description": "Actual record ID. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanNullableAPIResponse" }, "example": {"Success":true,"Data":true,"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } } }, "/api/data/v1/Contact/bulk": { "post": { "tags": [ "Contact" ], "summary": "Insert multiple contact records", "description": "Validates the object record details and creates multiple records in the given object.", "parameters": [ { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequestExample" }, "example": "[{\"Account\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Name\":\"Contact Name\",\"FirstName\":\"Contact First Name\",\"LastName\":\"Contact Last Name\",\"AssistantName\":\"Assistant Name\",\"Department\":\"QA\",\"Description\":\"Sample Contact Rec\",\"DoNotCall\":\"false\",\"Email\":\"test@email.com\",\"IsEmailBounced\":true,\"EmailBouncedDate\":\"2021-02-25\",\"EmailBouncedReason\":\"Failure\",\"LeadSource\":\"Lead Source\",\"AssistantPhone\":\"1111111111\",\"Birthdate\":\"2021-02-25\",\"Fax\":\"TestFAX\",\"HasOptedOutOfEmail\":\"false\",\"HasOptedOutOfFax\":\"false\",\"HomePhone\":\"1111111111\",\"MailingAddress\":\"Mailing Address\",\"MailingCity\":\"Mailing City\",\"MailingCountry\":\"Mailing Country\",\"MailingCountryCode\":\"Mailing Country Code\",\"MailingPostalCode\":\"Mailing Postal Code\",\"MailingState\":\"Mailing State\",\"MailingStreet\":\"Mailing Street\",\"MobilePhone\":\"1111111111\",\"OtherAddress\":\"Other Address\",\"OtherCity\":\"Other City\",\"OtherCountry\":\"Other Country\",\"OtherCountryCode\":\"Other Country Code\",\"OtherPhone\":\"1111111111\",\"OtherPostalCode\":\"Other Postal Code\",\"OtherState\":\"Other State\",\"OtherStreet\":\"Other Street\",\"Owner\":{\"Id\":\"Guid\",\"Name\":\"User Name\"},\"Phone\":\"1111111111\",\"PhotoUrl\":\"https://test.com/123\",\"Salutation\":\"Salutation\",\"Title\":\"Title\"},{\"Account\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Name\":\"Contact Name\",\"FirstName\":\"Contact First Name\",\"LastName\":\"Contact Last Name\",\"AssistantName\":\"Assistant Name\",\"Department\":\"QA\",\"Description\":\"Sample Contact Rec\",\"DoNotCall\":\"false\",\"Email\":\"test@email.com\",\"IsEmailBounced\":true,\"EmailBouncedDate\":\"2021-02-25\",\"EmailBouncedReason\":\"Failure\",\"LeadSource\":\"Lead Source\",\"AssistantPhone\":\"1111111111\",\"Birthdate\":\"2021-02-25\",\"Fax\":\"TestFAX\",\"HasOptedOutOfEmail\":\"false\",\"HasOptedOutOfFax\":\"false\",\"HomePhone\":\"1111111111\",\"MailingAddress\":\"Mailing Address\",\"MailingCity\":\"Mailing City\",\"MailingCountry\":\"Mailing Country\",\"MailingCountryCode\":\"Mailing Country Code\",\"MailingPostalCode\":\"Mailing Postal Code\",\"MailingState\":\"Mailing State\",\"MailingStreet\":\"Mailing Street\",\"MobilePhone\":\"1111111111\",\"OtherAddress\":\"Other Address\",\"OtherCity\":\"Other City\",\"OtherCountry\":\"Other Country\",\"OtherCountryCode\":\"Other Country Code\",\"OtherPhone\":\"1111111111\",\"OtherPostalCode\":\"Other Postal Code\",\"OtherState\":\"Other State\",\"OtherStreet\":\"Other Street\",\"Owner\":{\"Id\":\"Guid\",\"Name\":\"User Name\"},\"Phone\":\"1111111111\",\"PhotoUrl\":\"https://test.com/123\",\"Salutation\":\"Salutation\",\"Title\":\"Title\"}]" } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListAPIResponse" }, "example": {"Success":true,"Data":["36a6a3b2-d0e1-4689-a74f-330230dc941d","cac38445-068d-42ff-8065-b69fe16ba66b","780cdb79-9ece-430a-a843-c561293995d0"],"StatusCode":"Created"} } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "Contact" ], "summary": "Update multiple contact records", "description": "Validates the object record details and updates multiple records in the given object.", "parameters": [ { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } }, { "name": "EnforceOptimisticLocking", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequestExample" }, "example": "[{\"Account\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Name\":\"Contact Name\",\"FirstName\":\"Contact First Name\",\"LastName\":\"Contact Last Name\",\"AssistantName\":\"Assistant Name\",\"Department\":\"QA\",\"Description\":\"Sample Contact Rec\",\"DoNotCall\":\"false\",\"Email\":\"test@email.com\",\"IsEmailBounced\":true,\"EmailBouncedDate\":\"2021-02-25\",\"EmailBouncedReason\":\"Failure\",\"LeadSource\":\"Lead Source\",\"AssistantPhone\":\"1111111111\",\"Birthdate\":\"2021-02-25\",\"Fax\":\"TestFAX\",\"HasOptedOutOfEmail\":\"false\",\"HasOptedOutOfFax\":\"false\",\"HomePhone\":\"1111111111\",\"MailingAddress\":\"Mailing Address\",\"MailingCity\":\"Mailing City\",\"MailingCountry\":\"Mailing Country\",\"MailingCountryCode\":\"Mailing Country Code\",\"MailingPostalCode\":\"Mailing Postal Code\",\"MailingState\":\"Mailing State\",\"MailingStreet\":\"Mailing Street\",\"MobilePhone\":\"1111111111\",\"OtherAddress\":\"Other Address\",\"OtherCity\":\"Other City\",\"OtherCountry\":\"Other Country\",\"OtherCountryCode\":\"Other Country Code\",\"OtherPhone\":\"1111111111\",\"OtherPostalCode\":\"Other Postal Code\",\"OtherState\":\"Other State\",\"OtherStreet\":\"Other Street\",\"Owner\":{\"Id\":\"Guid\",\"Name\":\"User Name\"},\"Phone\":\"1111111111\",\"PhotoUrl\":\"https://test.com/123\",\"Salutation\":\"Salutation\",\"Title\":\"Title\"},{\"Account\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Name\":\"Contact Name\",\"FirstName\":\"Contact First Name\",\"LastName\":\"Contact Last Name\",\"AssistantName\":\"Assistant Name\",\"Department\":\"QA\",\"Description\":\"Sample Contact Rec\",\"DoNotCall\":\"false\",\"Email\":\"test@email.com\",\"IsEmailBounced\":true,\"EmailBouncedDate\":\"2021-02-25\",\"EmailBouncedReason\":\"Failure\",\"LeadSource\":\"Lead Source\",\"AssistantPhone\":\"1111111111\",\"Birthdate\":\"2021-02-25\",\"Fax\":\"TestFAX\",\"HasOptedOutOfEmail\":\"false\",\"HasOptedOutOfFax\":\"false\",\"HomePhone\":\"1111111111\",\"MailingAddress\":\"Mailing Address\",\"MailingCity\":\"Mailing City\",\"MailingCountry\":\"Mailing Country\",\"MailingCountryCode\":\"Mailing Country Code\",\"MailingPostalCode\":\"Mailing Postal Code\",\"MailingState\":\"Mailing State\",\"MailingStreet\":\"Mailing Street\",\"MobilePhone\":\"1111111111\",\"OtherAddress\":\"Other Address\",\"OtherCity\":\"Other City\",\"OtherCountry\":\"Other Country\",\"OtherCountryCode\":\"Other Country Code\",\"OtherPhone\":\"1111111111\",\"OtherPostalCode\":\"Other Postal Code\",\"OtherState\":\"Other State\",\"OtherStreet\":\"Other Street\",\"Owner\":{\"Id\":\"Guid\",\"Name\":\"User Name\"},\"Phone\":\"1111111111\",\"PhotoUrl\":\"https://test.com/123\",\"Salutation\":\"Salutation\",\"Title\":\"Title\"}]" } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" } } }, "delete": { "tags": [ "Contact" ], "summary": "Delete multiple contact records", "description": "Removes multiple records from the given object.", "parameters": [ { "name": "IncludeDeleteResultStatus", "in": "query", "description": "Set to true to get the delete status in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Multiple record IDs to be deleted. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "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" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":true,"Data":"DeletedRecordIds : [8d9eaedc-f380-4f57-831f-45cf9cdc5c2d,f9d71b3f-a0d3-4354-800f-76933308db3d]","StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "Contact" ], "summary": "Upsert multiple contact records", "description": "Validates the record details and updates if id exists else inserts if it does not exist in the given object.", "parameters": [ { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } }, { "name": "EnforceOptimisticLocking", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } }, "text/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" } } } }, "/api/data/v1/Contact/query": { "post": { "tags": [ "Contact" ], "summary": "Execute single query", "description": "Validates and executes the query request for the given object and specifying whether the total record count should be included in the response.", "parameters": [ { "name": "IncludeTotalCount", "in": "query", "description": "Set to true to get the total count of records in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Actual query to be executed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Query" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Query" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Query" } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryListAPIResponse" }, "example": {"Success":true,"RecordCount":1,"Data":[{"Name":"System Admin","Id":"1136f38e-0ea4-4186-9b7f-f04eaeb3368a"}],"StatusCode":"OK"} } } } } } }, "/api/data/v1/Contact/recordtypes": { "get": { "tags": [ "Contact" ], "summary": "Get List of RecordType", "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" }, "404": { "description": "Record not found" } } } }, "/api/data/v1/Opportunity": { "post": { "tags": [ "Opportunity" ], "summary": "Insert a new opportunity record", "description": "Validates the record details and inserts if it does not exist in the given object.", "parameters": [ { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityRequestExample" }, "example": "{\"Name\":\"Opportunity\",\"Account\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Contact\":{\"Id\":\"Guid\",\"Name\":\"Contact Name\"},\"Description\":\"Test\",\"FiscalYear\":\"2022\",\"ForecastCategory\":\"Forecast Category\",\"ForecastCategoryName\":\"Forecast Category Name\",\"HasOpportunityLineItem\":\"true\",\"HasOpenActivity\":false,\"LeadSource\":\"Lead Source\",\"StageName\":\"Stage Name\",\"TotalOpportunityQuantity\":\"11111.11\"}" } } }, "responses": { "400": { "description": "Found unknown field(s)" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"User doesn't have permission on 'account_p' object."}],"StatusCode":"OK"} } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":true,"Data":"65439574-b38d-4dd2-9a81-c3b8ead11469","StatusCode":"Created"} } } } } }, "get": { "tags": [ "Opportunity" ], "summary": "Get all opportunity records", "description": "Returns a list of all records for the given object.", "parameters": [ { "name": "criteria", "in": "query", "description": "Search criteria for the users. **For example**: IsActive = 'true'. **Note**: The criteria field (in this case, IsActive) should be indexed.", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "Number of records in each page. **For example**: 5, It will display 5 records on each page.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "Number of pages to be fetched. **For example**: 2, It will fetch the second page with the number of records (mentioned in the pageSize parameter).**Note**:The page Index starts from 1.", "schema": { "type": "integer", "format": "int32" } }, { "name": "sortField", "in": "query", "description": "Field name for sorting. **For example**: FirstName. **Note**: The sort field (in this case, FirstName) should be indexed or sortable.", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "description": "Sort direction for the data.", "schema": { "$ref": "#/components/schemas/SortDirection" } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryListAPIResponse" }, "example": {"Success":true,"RecordCount":1,"Data":[{"Name":"System Admin","Id":"85530710-0347-4284-ab18-ab4ca988ce09"}],"StatusCode":"OK"} } } } } } }, "/api/data/v1/Opportunity/{id}": { "get": { "tags": [ "Opportunity" ], "summary": "Get a opportunity record using opportunity record ID", "description": "Checks the record ID in the given object and fetches the record if it exists.", "parameters": [ { "name": "id", "in": "path", "description": "Actual record ID. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" }, "404": { "description": "Record not found" } } }, "put": { "tags": [ "Opportunity" ], "summary": "Update a opportunity record", "description": "Updates the record based on the object, record ID, and the details of the record that you want to update.", "parameters": [ { "name": "id", "in": "path", "description": "Actual record ID. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "required": true, "schema": { "type": "string" } }, { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } }, { "name": "EnforceOptimisticLocking", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityRequestExample" }, "example": "{\"Name\":\"Opportunity\",\"Account\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Contact\":{\"Id\":\"Guid\",\"Name\":\"Contact Name\"},\"Description\":\"Test\",\"FiscalYear\":\"2022\",\"ForecastCategory\":\"Forecast Category\",\"ForecastCategoryName\":\"Forecast Category Name\",\"HasOpportunityLineItem\":\"true\",\"HasOpenActivity\":false,\"LeadSource\":\"Lead Source\",\"StageName\":\"Stage Name\",\"TotalOpportunityQuantity\":\"11111.11\"}" } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryAPIResponse" }, "example": {"Success":true,"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "Opportunity" ], "summary": "Delete a opportunity record", "description": "Validates the record based on the record ID and removes it from the given object.", "parameters": [ { "name": "id", "in": "path", "description": "Actual record ID. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanNullableAPIResponse" }, "example": {"Success":true,"Data":true,"StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } } }, "/api/data/v1/Opportunity/bulk": { "post": { "tags": [ "Opportunity" ], "summary": "Insert multiple opportunity records", "description": "Validates the object record details and creates multiple records in the given object.", "parameters": [ { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityRequestExample" }, "example": "[{\"Name\":\"Opportunity\",\"Account\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Contact\":{\"Id\":\"Guid\",\"Name\":\"Contact Name\"},\"Description\":\"Test\",\"FiscalYear\":\"2022\",\"ForecastCategory\":\"Forecast Category\",\"ForecastCategoryName\":\"Forecast Category Name\",\"HasOpportunityLineItem\":\"true\",\"HasOpenActivity\":false,\"LeadSource\":\"Lead Source\",\"StageName\":\"Stage Name\",\"TotalOpportunityQuantity\":\"11111.11\"},{\"Name\":\"Opportunity\",\"Account\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Contact\":{\"Id\":\"Guid\",\"Name\":\"Contact Name\"},\"Description\":\"Test\",\"FiscalYear\":\"2022\",\"ForecastCategory\":\"Forecast Category\",\"ForecastCategoryName\":\"Forecast Category Name\",\"HasOpportunityLineItem\":\"true\",\"HasOpenActivity\":false,\"LeadSource\":\"Lead Source\",\"StageName\":\"Stage Name\",\"TotalOpportunityQuantity\":\"11111.11\"}]" } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringListAPIResponse" }, "example": {"Success":true,"Data":["36a6a3b2-d0e1-4689-a74f-330230dc941d","cac38445-068d-42ff-8065-b69fe16ba66b","780cdb79-9ece-430a-a843-c561293995d0"],"StatusCode":"Created"} } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "Opportunity" ], "summary": "Update multiple opportunity records", "description": "Validates the object record details and updates multiple records in the given object.", "parameters": [ { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } }, { "name": "EnforceOptimisticLocking", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityRequestExample" }, "example": "[{\"Name\":\"Opportunity\",\"Account\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Contact\":{\"Id\":\"Guid\",\"Name\":\"Contact Name\"},\"Description\":\"Test\",\"FiscalYear\":\"2022\",\"ForecastCategory\":\"Forecast Category\",\"ForecastCategoryName\":\"Forecast Category Name\",\"HasOpportunityLineItem\":\"true\",\"HasOpenActivity\":false,\"LeadSource\":\"Lead Source\",\"StageName\":\"Stage Name\",\"TotalOpportunityQuantity\":\"11111.11\"},{\"Name\":\"Opportunity\",\"Account\":{\"Id\":\"Guid\",\"Name\":\"Account Name\"},\"Contact\":{\"Id\":\"Guid\",\"Name\":\"Contact Name\"},\"Description\":\"Test\",\"FiscalYear\":\"2022\",\"ForecastCategory\":\"Forecast Category\",\"ForecastCategoryName\":\"Forecast Category Name\",\"HasOpportunityLineItem\":\"true\",\"HasOpenActivity\":false,\"LeadSource\":\"Lead Source\",\"StageName\":\"Stage Name\",\"TotalOpportunityQuantity\":\"11111.11\"}]" } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" } } }, "delete": { "tags": [ "Opportunity" ], "summary": "Delete multiple opportunity records", "description": "Removes multiple records from the given object.", "parameters": [ { "name": "IncludeDeleteResultStatus", "in": "query", "description": "Set to true to get the delete status in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Multiple record IDs to be deleted. **For example**: 2614d72c-edfc-4dc5-b72f-45104fe5ef43.", "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" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":true,"Data":"DeletedRecordIds : [8d9eaedc-f380-4f57-831f-45cf9cdc5c2d,f9d71b3f-a0d3-4354-800f-76933308db3d]","StatusCode":"OK"} } } }, "404": { "description": "Not Found" } } }, "patch": { "tags": [ "Opportunity" ], "summary": "Upsert multiple opportunity records", "description": "Validates the record details and updates if id exists else inserts if it does not exist in the given object.", "parameters": [ { "name": "IncludeRecordPayloadInResponse", "in": "query", "description": "Set to true to get the payload in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } }, { "name": "EnforceOptimisticLocking", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Details about the record. **For example**: Name = \"Mark\", Description = \"Description\". **Note**: The fields/properties should be part of the schema/metadata created for the object(in this case, Name and Description should be a field in schema). The schema/metadata can be generated using schema manager API.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } }, "text/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { } } } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" } } } }, "/api/data/v1/Opportunity/query": { "post": { "tags": [ "Opportunity" ], "summary": "Execute single query", "description": "Validates and executes the query request for the given object and specifying whether the total record count should be included in the response.", "parameters": [ { "name": "IncludeTotalCount", "in": "query", "description": "Set to true to get the total count of records in response. **Note**: Default value set to false.", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Actual query to be executed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Query" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Query" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Query" } } } }, "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringObjectDictionaryListAPIResponse" }, "example": {"Success":true,"RecordCount":1,"Data":[{"Name":"System Admin","Id":"1136f38e-0ea4-4186-9b7f-f04eaeb3368a"}],"StatusCode":"OK"} } } } } } }, "/api/data/v1/Opportunity/recordtypes": { "get": { "tags": [ "Opportunity" ], "summary": "Get List of RecordType", "responses": { "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringAPIResponse" }, "example": {"Success":false,"Errors":[{"Message":"Internal server error occurred. Please contact admin."}],"StatusCode":"OK"} } } }, "200": { "description": "Success" }, "404": { "description": "Record not found" } } } } }, "components": { "schemas": { "AccountRequestExample": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name for the record.", "nullable": true }, "AccountNumber": { "type": "string", "description": "Account number", "nullable": true }, "AccountSource": { "type": "string", "description": "Account source", "nullable": true }, "BillingAddress": { "type": "string", "description": "Billing address", "nullable": true }, "BillingCity": { "type": "string", "description": "Billing city", "nullable": true }, "ChannelProgramName": { "type": "string", "description": "Channel program name", "nullable": true }, "Industry": { "type": "string", "description": "Industry", "nullable": true }, "IsCustomerPortal": { "type": "string", "description": "Is customer portal", "nullable": true }, "IsPartner": { "type": "boolean", "description": "Is partner" }, "AnnualRevenue": { "type": "integer", "description": "Annual revenue", "format": "int32" }, "BillingCountry": { "type": "string", "description": "Billing country", "nullable": true }, "BillingCountryCode": { "type": "string", "description": "Billing country code", "nullable": true }, "BillingPostalCode": { "type": "string", "description": "Billing postal code", "nullable": true }, "BillingState": { "type": "string", "description": "Billing state", "nullable": true }, "BillingStreet": { "type": "string", "description": "Billing street", "nullable": true }, "ChannelProgramLevelName": { "type": "string", "description": "Channel program level name", "nullable": true }, "Description": { "type": "string", "description": "Description", "nullable": true }, "Fax": { "type": "string", "description": "Fax", "nullable": true }, "Owner": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Owner Id and Name associated with record", "nullable": true }, "Ownership": { "type": "string", "description": "Ownership", "nullable": true }, "Parent": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Parent", "nullable": true }, "Phone": { "type": "string", "description": "Phone number", "nullable": true }, "PhotoUrl": { "type": "string", "description": "Photo Url", "nullable": true }, "Rating": { "type": "string", "description": "Rating", "nullable": true }, "ShippingAddress": { "type": "string", "description": "Shipping address", "nullable": true }, "ShippingCity": { "type": "string", "description": "Shipping city", "nullable": true }, "ShippingCountry": { "type": "string", "description": "Shipping country", "nullable": true }, "ShippingCountryCode": { "type": "string", "description": "Shipping country code", "nullable": true }, "ShippingPostalCode": { "type": "string", "description": "Shipping postal code", "nullable": true }, "ShippingState": { "type": "string", "description": "Shipping state", "nullable": true }, "ShippingStreet": { "type": "string", "description": "Shipping street", "nullable": true }, "Site": { "type": "string", "description": "Site", "nullable": true }, "Type": { "type": "string", "description": "Type", "nullable": true }, "Website": { "type": "string", "description": "Website", "nullable": true }, "PriceList": { "type": "object", "additionalProperties": { "type": "string" }, "description": "PriceList Id and Name associated with record", "nullable": true } }, "additionalProperties": false, "description": "Account Request Example" }, "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 }, "ContactRequestExample": { "type": "object", "properties": { "Account": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Account Id and Name associated with record", "nullable": true }, "Name": { "type": "string", "description": "Name for record", "nullable": true }, "FirstName": { "type": "string", "description": "First name for record", "nullable": true }, "LastName": { "type": "string", "description": "Last name for record", "nullable": true }, "AssistantName": { "type": "string", "description": "Name of assistant", "nullable": true }, "Department": { "type": "string", "description": "Department name", "nullable": true }, "Description": { "type": "string", "description": "Description for the record", "nullable": true }, "DoNotCall": { "type": "string", "description": "Call options.", "nullable": true }, "Email": { "type": "string", "description": "Email Id", "nullable": true }, "IsEmailBounced": { "type": "boolean", "description": "Is Email bounced" }, "EmailBouncedDate": { "type": "string", "description": "Email bounced date", "nullable": true }, "EmailBouncedReason": { "type": "string", "description": "Email bounced reason", "nullable": true }, "LeadSource": { "type": "string", "description": "Lead source", "nullable": true }, "AssistantPhone": { "type": "string", "description": "Assistant phone number", "nullable": true }, "Birthdate": { "type": "string", "description": "Birthdate", "nullable": true }, "Fax": { "type": "string", "description": "Fax number", "nullable": true }, "HasOptedOutOfEmail": { "type": "string", "description": "Email settings", "nullable": true }, "HasOptedOutOfFax": { "type": "string", "description": "Fax settings", "nullable": true }, "HomePhone": { "type": "string", "description": "Home phone number", "nullable": true }, "MailingAddress": { "type": "string", "description": "Mailing address", "nullable": true }, "MailingCity": { "type": "string", "description": "Mailing city", "nullable": true }, "MailingCountry": { "type": "string", "description": "Mailing country", "nullable": true }, "MailingCountryCode": { "type": "string", "description": "Mailing country code", "nullable": true }, "MailingPostalCode": { "type": "string", "description": "Mailing postal code", "nullable": true }, "MailingState": { "type": "string", "description": "Mailing state", "nullable": true }, "MailingStreet": { "type": "string", "description": "Mailing street", "nullable": true }, "MobilePhone": { "type": "string", "description": "Mobile phone number", "nullable": true }, "OtherAddress": { "type": "string", "description": "Alternate address", "nullable": true }, "OtherCity": { "type": "string", "description": "Alternate city", "nullable": true }, "OtherCountry": { "type": "string", "description": "Alternate country", "nullable": true }, "OtherCountryCode": { "type": "string", "description": "Alternate country code", "nullable": true }, "OtherPhone": { "type": "string", "description": "Alternate phone number", "nullable": true }, "OtherPostalCode": { "type": "string", "description": "Alternate postal code", "nullable": true }, "OtherState": { "type": "string", "description": "Alternate state", "nullable": true }, "OtherStreet": { "type": "string", "description": "Alternate street", "nullable": true }, "Owner": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Owner Id and Name associated with record", "nullable": true }, "Phone": { "type": "string", "description": "Phone Number", "nullable": true }, "PhotoUrl": { "type": "string", "description": "Photo Url", "nullable": true }, "Salutation": { "type": "string", "description": "Salutation", "nullable": true }, "Title": { "type": "string", "description": "Title", "nullable": true } }, "additionalProperties": false, "description": "Contact Request Example" }, "DeleteByCriteriaRequest": { "type": "object", "properties": { "ObjectName": { "type": "string", "description": "Object from which the records need to be deleted.", "nullable": true }, "Criteria": { "type": "string", "description": "Delete criteria for the Records. **For example**: IsActive = 'true'. **Note**: The criteria field (in this case, IsActive) should be indexed.", "nullable": true }, "PageSize": { "type": "integer", "description": "The number of records to display on each page.", "format": "int32", "nullable": true, "deprecated": true }, "PageNumber": { "type": "integer", "description": "The page number of the result set to view.", "format": "int32", "nullable": true, "deprecated": true }, "NumberOfRecordsToDelete": { "type": "integer", "description": "Number of records to delete. \r\nIf NumberOfRecordsToDelete is provided PageNumber and PageSize will be ignored.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Criteria based request for delete." }, "ErrorDetail": { "type": "object", "properties": { "Message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "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" }, "OpportunityRequestExample": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name for the record", "nullable": true }, "Account": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Account Id and Name associated with record", "nullable": true }, "Contact": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Contact Id and Name associated with record", "nullable": true }, "Description": { "type": "string", "description": "Description for the record", "nullable": true }, "FiscalYear": { "type": "string", "description": "Financial reporting year", "nullable": true }, "ForecastCategory": { "type": "string", "description": "Forcast category for record", "nullable": true }, "ForecastCategoryName": { "type": "string", "description": "Name of forcast category for record", "nullable": true }, "HasOpportunityLineItem": { "type": "string", "description": "Has opportunity lineitem", "nullable": true }, "HasOpenActivity": { "type": "boolean", "description": "Has open activity" }, "LeadSource": { "type": "string", "description": "Lead source for record", "nullable": true }, "StageName": { "type": "string", "description": "Stage Name for record", "nullable": true }, "TotalOpportunityQuantity": { "type": "string", "description": "Total opportuninty qunatity for record", "nullable": true } }, "additionalProperties": false, "description": "Opportunity Request Example" }, "OrderBy": { "enum": [ "Ascending", "Descending" ], "type": "string" }, "Query": { "type": "object", "properties": { "ObjectName": { "type": "string", "description": "Name of object on which querying needs to be done.", "nullable": true }, "Criteria": { "type": "string", "nullable": true }, "Select": { "type": "array", "items": { "type": "string" }, "description": "The fields which are to be displayed.", "nullable": true }, "Distinct": { "type": "boolean", "description": "Select true to get distinct records" }, "Limit": { "type": "integer", "description": "Limit set for records to be fetched. **For example**: Limit = 100, This will fetch 100 records matching the criteria.", "format": "int32", "nullable": true }, "Skip": { "type": "integer", "description": "Number of records to be skipped.", "format": "int32", "nullable": true }, "Sort": { "$ref": "#/components/schemas/Sort" }, "GroupBy": { "type": "array", "items": { "type": "string" }, "description": "List of field names which are to be grouped.", "nullable": true } }, "additionalProperties": false, "description": "Schema Model for Query" }, "Sort": { "type": "object", "properties": { "FieldName": { "type": "string", "description": "Field name for sort. **For example**: FirstName. **Note**: The sort field (in this case, FirstName) should be indexed or sortable.", "nullable": true }, "OrderBy": { "$ref": "#/components/schemas/OrderBy" } }, "additionalProperties": false, "description": "Sort information for records." }, "SortDirection": { "enum": [ "Ascending", "Descending" ], "type": "string" }, "StringAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "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 }, "StringListAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "type": "array", "items": { "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 }, "StringObjectDictionaryAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "type": "object", "additionalProperties": { }, "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 }, "StringObjectDictionaryListAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "type": "array", "items": { "type": "object", "additionalProperties": { } }, "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 }, "StringObjectDictionaryListListAPIResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "RecordCount": { "type": "integer", "format": "int64", "nullable": true }, "Data": { "type": "array", "items": { "type": "array", "items": { "type": "object", "additionalProperties": { } } }, "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 }, "UpdateManyByCriteriaRequest": { "type": "object", "properties": { "ObjectName": { "type": "string", "description": "Object from which the records need to be updated.", "nullable": true }, "ValuesToUpdate": { "type": "object", "additionalProperties": { }, "description": "Tha values which needs to be updated **For example**: Name = \"Mark\"", "nullable": true }, "Criteria": { "type": "string", "description": "Update criteria for the Records. **For example**: IsActive = 'true'. **Note**: The criteria field (in this case, IsActive) should be indexed.", "nullable": true }, "PageNumber": { "type": "integer", "description": "The page number of the result set to view.", "format": "int32", "nullable": true }, "PageSize": { "type": "integer", "description": "The number of records to display on each page.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Criteria based request for bulk updating records." } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }