CRM in Cloud Web API documentations

Security

This controller works under the system security rules and constraints.
For more details, refer to the Authentication section

Note

The following guidelines are intended to illustrate the features and features of this Web API controller.

Aliases

This controller can be invoked by other names besides the default one.

This means that, referring to the routing grammar ({schema}://{host}/api/{version}/{controller}/{details}/{action}/{id}?{querystring}) it is possible to use a different fragment for the {controller} component.

Below is the list of these aliases for the fragment {controller}, sorted by suggested preference of use.

Alias	Path
Flows	/api/v1/Flows
Flow	/api/v1/Flow

Authentication

JWT Token

In order to invoke the REST API, it is necessary to obtain an authentication token via the appropriate service /Auth/Login

For more details, please see the appropriate section of the documentations.

Bearer Authentication

Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens.

For more details, please see the appropriate section of the documentations.

Identification of the calling application

Some of the REST API functions can only be used if (in addition to proper user authentication) a declaration of the calling application is also performed.

For more details, please see the appropriate section of the documentations.

Actions & Paths

These are the REST actions that can be performed via the Web API infrastructure.
The actions are grouped by "topic".
Click on a "topic" to view the different actions contained in it.

Each action corresponds to a method in the class of the Web API controller, and a set of routing paths that can be used to invoke it.

Explore by topics

Topic name	Most commonly used actions
CRUD	/api/v1/Flow/CreateOrUpdate /api/v1/Flow/ /api/v1/Flow/Exists /api/v1/Flow/ /api/v1/Flow/Humanize /api/v1/Flow/GetFull /api/v1/Flow/GetNewInstance
Multiple CRUD	/api/v1/Flow/MultipleDelete /api/v1/Flow/MultipleExists /api/v1/Flow/MultipleGet
External References	/api/v1/Flow/SearchIdsByExternalReference /api/v1/Flow/GetByExternalReference /api/v1/Flow/DeleteByExternalReference /api/v1/Flow/MapByExternalReference /api/v1/Flow/ResetExternalReferences /api/v1/Flow/UnmapByExternalReference /api/v1/Flow/GetIdsMappedByExternalReference /api/v1/Flow/GetItemsMappedByExternalReference /api/v1/Flow/GetIdsNotMappedByExternalReference /api/v1/Flow/GetIdsByExternalReference /api/v1/Flow/GetItemsNotMappedByExternalReference
Misc	/api/v1/Flow/Success /api/v1/Flow/Fail /api/v1/Flow/Abort /api/v1/Flow/Log /api/v1/Flow/LastFlow /api/v1/Flow/StartManualTrigger /api/v1/Flow/Photo /api/v1/Flow/GetSample /api/v1/Flow/GetBoDeleteModes /api/v1/Flow/FreeFields /api/v1/Flow/Recent /api/v1/Flow/GetHash /api/v1/Flow/PrintableFields
OData	/api/v1/Flow/SearchIds /api/v1/Flow/Search /api/v1/Flow/Count
Start	/api/v1/Flow/api/Flows/Start /api/v1/Flow/api/Flow/Start
Swagger	/api/v1/Flow/GetPolymorphicSchema /api/v1/Flow/GetStandardSchema /api/v1/Flow/GetSwagger

GET: /api/v1/Flow/

Routing template:

/api/{version}/Flow/

Produces:

HTTP 200: Int64 as application/json
HTTP 200: Int64 as text/json
HTTP 200: Int64 as application/xml
HTTP 200: Int64 as text/plain
HTTP 200: Int64 as application/octet-stream

Name	Type	Required	In	Features
trigger	string	YES	Path
crossId	integer	YES	Path	Format: int64
version	string	YES	Path

Name	Type	Required	In	Features
externalReference	string	NO	Query
excludeDeletedItems	boolean	NO	Query

Name	Type	Required	In	Features
serializePropertiesAsDictionary	boolean	NO	Query	Default: True
honorAcceptLanguageHeader	boolean	NO	Query	Default: False
generateSample	boolean	NO	Query	Default: False
sampleGenerationStrategy	SampleGenerationStrategy	NO	Query
useExtensions	boolean	NO	Query	Default: True
includeExplicitlyDeclaredVirtualProperties	boolean	NO	Query	Default: False

Name	Type	Required	In	Features
force	boolean	NO	Query	Default: False
sampleGenerationStrategy	SampleGenerationStrategy	NO	Query
useExtensions	boolean	NO	Query	Default: True

Name	Type	Required	In	Features
includeFull	boolean	NO	Query	Default: True
includeNesting	boolean	NO	Query	Default: True

Name	Type	Required	In	Features
filter	string	NO	Query
orderBy	string	NO	Query
skip	integer	NO	Query	Format: int64
top	integer	NO	Query	Format: int64
select	string	NO	Query

Name	Type	Required	In	Features
triggerId	integer	NO	Query	Format: int64
flowTemplateId	integer	NO	Query	Format: int64
crossId	integer	NO	Query	Format: int64

Name	Description
ActionResultDTO	Action Result
BoDeleteMode	Bo Delete Mode
BusinessObjectType	Business Object Type
CRMTables	CRM Tables
DeleteItemResult	Delete Item Result
DTOPropertyUsage	DTO Property Usage
ExistsItemResult	Exists Item Result
ExternalReferenceDTO	External Reference
FlowDTO	Flow
FlowLinkDTO	Flow Link
FlowLogDTO	Flow Log
FlowStepResult	Flow Step Result
FreeFieldsBOItemDTO	Free Fields BO Item
FreeFieldsBOItemLocalizingDTO	Free Fields BO Item Localizing
FreeFieldsBOTreeItemDTO	Free Fields BO Tree Item
FreeFieldsType	Free Fields Type
GetIdsMappedByExternalReferenceRequest	Get Ids Mapped By External Reference Request
GetItemResult`1[]	Get Item Result`1
GetItemsMappedByExternalReferenceRequest	Get Items Mapped By External Reference Request
Gravity	Gravity
IFlowTriggerReport	Flow Trigger Report
JToken	J Token
LinkItem	Link Item
LiquidStruct	Liquid Struct
LocalizeType	Localize Type
LocalizingDTO	Localizing
MultipleDeleteModel	Multiple Delete Model
MultipleExistsModel	Multiple Exists Model
MultipleGetModel	Multiple Get Model
SampleGenerationStrategy	Sample Generation Strategy

APIv1EnglishFlow

Flow

Security

Note

Aliases

Authentication

JWT Token

Bearer Authentication

Identification of the calling application

Actions & Paths

GET: /api/v1/Flow/

Routing template:

Produces:

Response: 200 (Success) ApiActionResult

Samples

Try this !

DELETE: /api/v1/Flow/{id}

Parameters:

Produces:

Response: 200 (Success) Boolean

Samples

Try this !

GET: /api/v1/Flow/{id}

Parameters:

Produces:

Response: 200 (Success) FlowDTO

Samples

Try this !

POST: /api/v1/Flow/{id}/Abort

Parameters:

Produces:

Response: 400 (Bad Request) ActionResultDTO

Samples

Try this !

GET: /api/v1/Flow/{id}/Exists

Parameters:

Produces:

Response: 200 (Success) Boolean

Samples

Try this !

POST: /api/v1/Flow/{id}/Fail

Parameters:

Produces:

Response: 400 (Bad Request) ActionResultDTO

Samples

Try this !

GET: /api/v1/Flow/{id}/FreeFields

Parameters:

Produces:

Response: 200 (Success) FreeFieldsBOItemDTO

Samples

Try this !

GET: /api/v1/Flow/{id}/GetFull

Parameters:

Produces:

Response: 200 (Success) FlowDTO

Samples

Try this !

GET: /api/v1/Flow/{id}/GetHash

Parameters:

Produces:

Response: 200 (Success) String

Samples

Try this !

GET: /api/v1/Flow/{id}/Humanize

Parameters:

Produces:

Response: 200 (Success) FlowDTO

Samples

Try this !

POST: /api/v1/Flow/{id}/LastFlow

Parameters:

Produces:

Response: 400 (Bad Request) FlowLinkDTO

Samples

Try this !

GET: /api/v1/Flow/{id}/Log

Parameters:

Produces:

Response: 400 (Bad Request) FlowLogDTO

API v1 English Flow