Dev_SalesforceAPI (1.0.0)

Download OpenAPI specification:Download

The Salesforce Integration API allows seamless integration between TCP application and Salesforce, a leading customer relationship management platform. This API documentation provides a comprehensive overview of the available endpoints and their functionalities, enabling you to leverage Salesforces features and data within TCP application.

/credit_card

header Parameters

x-api-key required	string
Authorization required	string

Request Body schema: application/json
required

Active__c required	boolean
Card_number__c required	string
Contact_Owner__c required	string
Opportunity_New__c required	string
Updated_via_Portal__c required	boolean
expiration_month__c required	string
expiration_year__c required	string
card_number_hidden__c	string
expiration_month_hidden__c	string
expiration_year_hidden__c	string

Responses

Response Schema: application/json

success	boolean
message	string
	object

Request samples

Payload

Content type

application/json

{"Card_number__c": "string",
"card_number_hidden__c": "string",
"expiration_month__c": "string",
"expiration_month_hidden__c": "string",
"expiration_year__c": "string",
"expiration_year_hidden__c": "string",
"Contact_Owner__c": "string",
"Active__c": true,
"Opportunity_New__c": "string",
"Updated_via_Portal__c": true
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"data": {"Id": "string",
"Card_number__c": "string"
}
}

/query/{id}

path Parameters

id

required

string

header Parameters

x-api-key required	string
Authorization	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/{sobjects}/deleted

path Parameters

sobjects

required

string

query Parameters

start

string

Starting date/time (Coordinated Universal Time (UTC)—not local— timezone) of the timespan for which to retrieve the data. The API ignores the seconds portion of the specified dateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC). The date and time must be formatted as described in Valid Date and DateTime Formats. The date/time value for start must chronologically precede end. This parameter should be URL-encoded.

end

string

Ending date/time (Coordinated Universal Time (UTC)—not local— timezone) of the timespan for which to retrieve the data. The API ignores the seconds portion of the specified dateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC). The date and time must be formatted as described in Valid Date and DateTime Formats. This parameter should be URL-encoded

header Parameters

x-api-key required	string
Authorization	string

Responses

Response Schema: application/json

deletedRecords	Array of arrays
earliestDateAvailable	string
latestDateCovered	string

Response samples

200

Content type

application/json

{"deletedRecords": [ ],
"earliestDateAvailable": "string",
"latestDateCovered": "string"
}

/update/{table}

path Parameters

table

required

string

header Parameters

x-api-key required	string
Authorization	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/update/{table}

path Parameters

table

required

string

header Parameters

x-api-key required	string
Authorization	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/update/{table}

path Parameters

table

required

string

header Parameters

x-api-key required	string
Authorization	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/bulk/jobs/ingest/{jobid}/successfulresults

path Parameters

jobid

required

string

header Parameters

x-api-key required	string
Authorization required	string

Responses

Response Schema: application/json

sf__Id	string
sf__Created	string
Name	string
ShippingCity	string
NumberOfEmployees	string
AnnualRevenue	string
Website	string
Description	string

Response samples

200

Content type

application/json

{"sf__Id": "string",
"sf__Created": "string",
"Name": "string",
"ShippingCity": "string",
"NumberOfEmployees": "string",
"AnnualRevenue": "string",
"Website": "string",
"Description": "string"
}

/bulk/jobs/ingest/{jobid}/failedresults

path Parameters

jobid

required

string

header Parameters

x-api-key required	string
Authorization required	string

Responses

Response Schema: application/json

sf__Error	string
sf__Id	string

Response samples

200

Content type

application/json

{"sf__Error": "string",
"sf__Id": "string"
}

/bulk/jobs/ingest/{jobid}

path Parameters

jobid

required

string

query Parameters

jobId

required

string

The ID of the job.

header Parameters

x-api-key required	string
Authorization	string

Responses

Response Schema: application/json

apexProcessingTime	string
apiActiveProcessingTime	string
apiVersion	string
assignmentRuleIdcolumnDelimiter	string
columnDelimiter	string
concurrencyMode	string
contentType	string
contentUrl	string
createdById	string
createdDate	string
externalIdFieldName	string
id	string
jobType	string
lineEnding	string
numberRecordsFailed	string
numberRecordsProcessed	string
object	string
operation	string
retries	string
state	string
systemModstamp	string
totalProcessingTime	string

Response samples

200

Content type

application/json

{"apexProcessingTime": "string",
"apiActiveProcessingTime": "string",
"apiVersion": "string",
"assignmentRuleIdcolumnDelimiter": "string",
"columnDelimiter": "string",
"concurrencyMode": "string",
"contentType": "string",
"contentUrl": "string",
"createdById": "string",
"createdDate": "string",
"externalIdFieldName": "string",
"id": "string",
"jobType": "string",
"lineEnding": "string",
"numberRecordsFailed": "string",
"numberRecordsProcessed": "string",
"object": "string",
"operation": "string",
"retries": "string",
"state": "string",
"systemModstamp": "string",
"totalProcessingTime": "string"
}

/bulk/jobs/ingest/{jobid}

path Parameters

jobid

required

string

header Parameters

x-api-key required	string
Authorization required	string Bearer token

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/bulk/jobs/ingest/{jobid}

path Parameters

jobid

required

string

header Parameters

x-api-key required	string
Authorization	string

Request Body schema: application/json
required

state

string

Responses

Response Schema: application/json

assignmentRuleId	string
apiVersion	string
columnDelimiter	string
concurrencyMode	string
contentType	string
contentUrl	string
createdById	string
createdDate	string
externalIdFieldName	string
id	string
jobType	string
lineEnding	string
object	string
operation	string
state	string
systemModstamp	string

Request samples

Payload

Content type

application/json

{"state": "string"
}

Response samples

200

Content type

application/json

{"assignmentRuleId": "string",
"apiVersion": "string",
"columnDelimiter": "string",
"concurrencyMode": "string",
"contentType": "string",
"contentUrl": "string",
"createdById": "string",
"createdDate": "string",
"externalIdFieldName": "string",
"id": "string",
"jobType": "string",
"lineEnding": "string",
"object": "string",
"operation": "string",
"state": "string",
"systemModstamp": "string"
}

/bulk/jobs/ingest/{jobid}/batches

path Parameters

jobid

required

string

header Parameters

x-api-key required	string
Authorization required	string

Responses

Response Schema: application/json

object (BatchJobsIngestResponse)

Response samples

200

Content type

application/json

{ }

/auth

header Parameters

x-api-key

required

string

Request Body schema: application/x-www-form-urlencoded
required

grant_type	string
assertion	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/sObject/{Account}/describe

path Parameters

Account

required

string

header Parameters

x-api-key required	string Using the API Key on the dashbroad of Developer Portal
Authorization	string Authorization: Bearer token

Responses

Response Schema: application/json

required	Array of objects
createable required	boolean
custom required	boolean
customSetting required	boolean
required	Array of objects
keyPrefix required	string
label required	string
name required	string
updateable required	boolean
required	object

Response samples

200

Content type

application/json

{"name": "string",
"fields": [{"length": 0,
"name": "string",
"type": "string",
"defaultValue": {"value": { }
},
"updateable": true,
"label": "string"
}
],
"updateable": true,
"label": "string",
"keyPrefix": "string",
"custom": true,
"urls": {"uiEditTemplate": "string",
"sobject": "string",
"uiDetailTemplate": "string"
},
"childRelationships": [{"field": "string",
"deprecatedAndHidden": true
}
],
"createable": true,
"customSetting": true
}

/update/{table}/{id}

path Parameters

table required	string
id required	string

header Parameters

x-api-key required	string
Authorization	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/update/{table}/{id}

path Parameters

table required	string
id required	string

header Parameters

x-api-key required	string
Authorization	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/update/{table}/{id}

path Parameters

table required	string
id required	string

header Parameters

x-api-key required	string
Authorization	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/update/{table}/{id}

path Parameters

table required	string
id required	string

header Parameters

x-api-key required	string
Authorization	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/bulk/jobs/ingest

query Parameters

isPkChunkingEnabled	string
jobType	string
queryLocator	string

header Parameters

x-api-key required	string
Authorization	string

Responses

Response Schema: application/json

done	boolean
	Array of objects
body	string The response body.

Response samples

200

Content type

application/json

{"done": true,
"records": [{"apiVersion": "string",
"columnDelimiter": "BACKQUOTE",
"concurrencyMode": "string",
"contentType": "string",
"contentUrl": "string",
"createdById": "string",
"createdDate": "string",
"id": "string",
"jobType": "BigObjectIngest",
"lineEnding": "LF",
"object": "string",
"operation": "insert",
"state": "Open",
"systemModstamp": "string"
}
],
"body": "string"
}

/bulk/jobs/ingest

header Parameters

x-api-key required	string
Authorization	string

Request Body schema: application/json
required

assignmentRuleId	string
columnDelimiter	string
contentType	string
externalIdFieldName	string
lineEnding	string
object	string
operation	string

Responses

Response Schema: application/json

apiVersion	string
assignmentRuleId	string
columnDelimiter	string
concurrencyMode	string
contentType	string
contentUrl	string
createdById	string
createdDate	string
externalIdFieldName	string
id	string
jobType	string
lineEnding	string
object	string
operation	string
state	string
systemModstamp	string

Request samples

Payload

Content type

application/json

{"assignmentRuleId": "string",
"columnDelimiter": "string",
"contentType": "string",
"externalIdFieldName": "string",
"lineEnding": "string",
"object": "string",
"operation": "string"
}

Response samples

200

Content type

application/json

{"apiVersion": "string",
"assignmentRuleId": "string",
"columnDelimiter": "string",
"concurrencyMode": "string",
"contentType": "string",
"contentUrl": "string",
"createdById": "string",
"createdDate": "string",
"externalIdFieldName": "string",
"id": "string",
"jobType": "string",
"lineEnding": "string",
"object": "string",
"operation": "string",
"state": "string",
"systemModstamp": "string"
}

/query

query Parameters

q

required

string

header Parameters

x-api-key required	string
Authorization	string

Responses

Response Schema: application/json

done	boolean
totalSize	number
records	Array of arrays

Response samples

200

Content type

application/json

{"done": true,
"totalSize": 0,
"records": [ ]
}

/upsert/{table}/{field}/{value}

path Parameters

table required	string
value required	string
field required	string

header Parameters

x-api-key required	string
Authorization	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/upsert/{table}/{field}/{value}

path Parameters

table required	string
value required	string
field required	string

header Parameters

x-api-key required	string
Authorization	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/create/{table}

path Parameters

table

required

string

header Parameters

x-api-key required	string
Authorization	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

/bulk/jobs/ingest/{jobid}/unprocessedrecords

path Parameters

jobid

required

string

header Parameters

x-api-key required	string
Authorization required	string

Responses

Response Schema: application/json

object (Empty Schema)

Response samples

200

Content type

application/json

{ }

Dev_SalesforceAPI (1.0.0)

/credit_card

header Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

/query/{id}

path Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

/{sobjects}/deleted

path Parameters

query Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

/update/{table}

path Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

/update/{table}

path Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

/update/{table}

path Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

/bulk/jobs/ingest/{jobid}/successfulresults

path Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

/bulk/jobs/ingest/{jobid}/failedresults

path Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

/bulk/jobs/ingest/{jobid}

path Parameters

query Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

/bulk/jobs/ingest/{jobid}

path Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

/bulk/jobs/ingest/{jobid}

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

/bulk/jobs/ingest/{jobid}/batches

path Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

/auth

header Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/json
required