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
Contracts	/api/v1/Contracts
Contract	/api/v1/Contract

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/Contract/CreateOrUpdate /api/v1/Contract/ /api/v1/Contract/Exists /api/v1/Contract/ /api/v1/Contract/Humanize /api/v1/Contract/GetFull /api/v1/Contract/GetNewInstance
Multiple CRUD	/api/v1/Contract/MultipleDelete /api/v1/Contract/MultipleExists /api/v1/Contract/MultipleGet
Documents	/api/v1/Contract/Documents /api/v1/Contract/DocumentsIds /api/v1/Contract/Documents/Count
External References	/api/v1/Contract/SearchIdsByExternalReference /api/v1/Contract/GetByExternalReference /api/v1/Contract/DeleteByExternalReference /api/v1/Contract/MapByExternalReference /api/v1/Contract/ResetExternalReferences /api/v1/Contract/UnmapByExternalReference /api/v1/Contract/GetIdsMappedByExternalReference /api/v1/Contract/GetItemsMappedByExternalReference /api/v1/Contract/GetIdsNotMappedByExternalReference /api/v1/Contract/GetIdsByExternalReference /api/v1/Contract/GetItemsNotMappedByExternalReference
Misc	/api/v1/Contract/GetContractsForCaller /api/v1/Contract/GetContractServicesForCaller /api/v1/Contract/CompanyChanged /api/v1/Contract/GetAddressString /api/v1/Contract/LinkedCompanyContracts /api/v1/Contract/Templates /api/v1/Contract/HtmlPreview /api/v1/Contract/PrintHtml /api/v1/Contract/GetDownloadUrl /api/v1/Contract/GetPostDownloadUrl /api/v1/Contract/Archive /api/v1/Contract/AsDataProduct /api/v1/Contract/GetBoDeleteModes /api/v1/Contract/FreeFields /api/v1/Contract/GetHash /api/v1/Contract/PrintableFields /api/v1/Contract/Photo /api/v1/Contract/Recent /api/v1/Contract/GetSample
OData	/api/v1/Contract/Count /api/v1/Contract/SearchIds /api/v1/Contract/Search
Preview	/api/v1/Contract/Previews /api/v1/Contract/Preview
Renewals	/api/v1/Contract/Renewals /api/v1/Contract/RenewalsIds /api/v1/Contract/Renewals/Count
Sections	/api/v1/Contract/Sections /api/v1/Contract/SectionsIds /api/v1/Contract/Sections/Count
Services	/api/v1/Contract/Services /api/v1/Contract/ServicesIds /api/v1/Contract/Services/Count
Swagger	/api/v1/Contract/GetDataProductSchema /api/v1/Contract/GetPolymorphicSchema /api/v1/Contract/GetPolymorphicStandardSchema /api/v1/Contract/GetStandardSchema /api/v1/Contract/GetSwagger

GET: /api/v1/Contract/

Routing template:

/api/{version}/Contract/

Produces:

HTTP 200: Int64 as application/json
HTTP 200: Int64 as text/json
HTTP 200: Int64 as application/json;IEEE754Compatible=false
HTTP 200: Int64 as application/json;IEEE754Compatible=true
HTTP 200: Int64 as application/xml
HTTP 200: Int64 as text/plain
HTTP 200: Int64 as application/octet-stream

Name	Type	Required	In	Features
id	integer	YES	Path	Format: int64
template	string	NO	Query
request	ContractPrintableRequest	NO	Query

Name	Type	Required	In	Features
honorAcceptLanguageHeader	boolean	NO	Query	Default: False
includeExplicitlyDeclaredVirtualProperties	boolean	NO	Query	Default: False

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	Description
BoDeleteMode	Bo Delete Mode
Boolean	Boolean
BusinessObjectType	Business Object Type
CatalogDTO	Catalog
ConsumptionType	Consumption Type
ContractBOContractJobOrderTaskPlannedDTO	Contract BO Contract Job Order Task Planned
ContractBOContractRenewalsDTO	Contract BO Contract Renewals
ContractBOContractSectionsDTO	Contract BO Contract Sections
ContractBOContractTypeOfServiceBOBillingRangeLockDTO	Contract BO Contract Type Of Service BO Billing Range Lock
ContractBOContractTypeOfServiceDTO	Contract BO Contract Type Of Service
ContractDTO	Contract
ContractPrintableRequest	Contract Printable Request
ContractServiceConsumptionConfigDTO	Contract Service Consumption Config
ContractServicesStatus	Contract Services Status
ContractsForCallerRequest	Contracts For Caller Request
CRMTables	CRM Tables
DeleteItemResult	Delete Item Result
ExistsItemResult	Exists Item Result
ExternalReferenceDTO	External Reference
FileCrossAttributes	File Cross Attributes
FileCrossDTO	File Cross
FileCrossTypes	File Cross Types
FilePreview	File Preview
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
IHelperResult	Helper Result
object	Int 32
JobOrderPlannedMode	Job Order Planned Mode
JobOrderTaskPlannedCrossMode	Job Order Task Planned Cross Mode
JobOrderTaskPlannedRollingStockMode	Job Order Task Planned Rolling Stock Mode
JobOrderTaskPlanningMode	Job Order Task Planning Mode
KindOfPrice	Kind Of Price
LinkItem	Link Item
LiquidStruct	Liquid Struct
LocalizeType	Localize Type
LocalizingDTO	Localizing
MapExternalReferenceRequest	Map External Reference Request
MultipleDeleteModel	Multiple Delete Model
MultipleExistsModel	Multiple Exists Model
MultipleGetModel	Multiple Get Model
PrintHtmlRequest	Print Html Request
PrintTemplateDTO	Print Template
RecentRouteType	Recent Route Type
RollingStockInContractDTO	Rolling Stock In Contract
SampleGenerationStrategy	Sample Generation Strategy
StandardSchemaVersion	Standard Schema Version
StorageDTO	Storage
Template	Template
TypeOfContractSection	Type Of Contract Section
TypeOfPrice	Type Of Price
TypeOfSection	Type Of Section
TypeOfService	Type Of Service
YearMode	Year Mode

APIv1EnglishContract

Contract

Security

Note

Aliases

Authentication

JWT Token

Bearer Authentication

Identification of the calling application

Actions & Paths

GET: /api/v1/Contract/

Routing template:

Produces:

Response: 200 (Success) ApiActionResult

Samples

Try this !

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

Parameters:

Produces:

Response: 200 (Success) Boolean

Samples

Try this !

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

Parameters:

Produces:

Response: 200 (Success) ContractDTO

Samples

Try this !

GET: /api/v1/Contract/{id}/Archive

Parameters:

Produces:

Response: 400 (Bad Request) integer

Samples

Try this !

GET: /api/v1/Contract/{id}/AsDataProduct

Parameters:

Produces:

Response: 200 (Success) ContractDTO

Samples

Try this !

GET: /api/v1/Contract/{id}/Documents

Parameters:

Produces:

Response: 200 (Success) StorageDTO

Samples

Try this !

GET: /api/v1/Contract/{id}/Documents/Count

Parameters:

Produces:

Response: 200 (Success) Int64

Samples

Try this !

GET: /api/v1/Contract/{id}/DocumentsIds

Parameters:

Produces:

Response: 200 (Success) Int64

Samples

Try this !

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

Parameters:

Produces:

Response: 200 (Success) Boolean

Samples

Try this !

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

Parameters:

Produces:

Response: 200 (Success) FreeFieldsBOItemDTO

Samples

Try this !

GET: /api/v1/Contract/{id}/GetDownloadUrl

Parameters:

Produces:

Response: 400 (Bad Request) string

Samples

Try this !

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

Parameters:

Produces:

Response: 200 (Success) ContractDTO

API v1 English Contract