CRM in Cloud Web API documentations

Sicurezza

Questo controller è sottoposto alle regole di security del sistema.
Per maggiori dettagli, fare riferimento alla sezione Authentication

Note

Le indicazioni riportate di seguito hanno lo scopo di illustrare le funzionalità e le caratteristiche di questo Web API controller.

Aliases

Questo controller è invocabile tramite altri nomi oltre a quello di default.

Ciò significa che, facendo riferimento alla grammatica di routing ({schema}://{host}/api/{version}/{controller}/{details}/{action}/{id}?{querystring}) è possibile utilizzare un fragment differente per il componente {controller}.

Di seguito è riportata la lista di tali alias per il fragment {controller}, in ordine di preferenza d'uso.

Alias	Path
Activities	/api/v1/Activities
Activity	/api/v1/Activity

Authentication

Token JWT

Al fine di potere invocare le API REST, è necessario ottenere un token di autenticazione tramite l’apposito servizio /Auth/Login.
Per maggiori informazioni fare riferimento all'apposita sezione di questa guida.

Bearer Authentication

La "Bearer Authentication" (tradotta "autenticazione al portatore", detta anche "autenticazione token") è uno schema di autenticazione HTTP che coinvolge un token di sicurezza denominato bearer token.

Per maggiori informazioni fare riferimento all'apposita sezione di questa guida.

Identificazione dell’applicazione chiamante

Alcune delle funzioni delle API REST possono essere utilizzate solamente se (oltre ad una corretta autenticazione dell’utente) si esegue anche una dichiarazione dell’applicazione chiamante.

Per maggiori informazioni fare riferimento all'apposita sezione di questa guida.

Actions & Paths

Di seguito sono elencate le azioni REST eseguibili tramite le Web API.
Le azioni sono raggruppate per "topic".
Clicca un "topic" per visualizzare le diverse azioni in esso contenute.

Ad ogni azione corrisponde un metodo interno alla classe del controller Web API, ed un set di paths di routing utilizzabili per invocarla.

Explore by topics

Topic name	Most commonly used actions
CRUD	/api/v1/Activity/CreateOrUpdate /api/v1/Activity/ /api/v1/Activity/Exists /api/v1/Activity/ /api/v1/Activity/Humanize /api/v1/Activity/GetFull /api/v1/Activity/GetNewInstance
Multiple CRUD	/api/v1/Activity/MultipleDelete /api/v1/Activity/MultipleExists /api/v1/Activity/MultipleGet
External References	/api/v1/Activity/SearchIdsByExternalReference /api/v1/Activity/GetByExternalReference /api/v1/Activity/DeleteByExternalReference /api/v1/Activity/MapByExternalReference /api/v1/Activity/ResetExternalReferences /api/v1/Activity/UnmapByExternalReference /api/v1/Activity/GetIdsMappedByExternalReference /api/v1/Activity/GetItemsMappedByExternalReference /api/v1/Activity/GetIdsNotMappedByExternalReference /api/v1/Activity/GetIdsByExternalReference /api/v1/Activity/GetItemsNotMappedByExternalReference
Misc	/api/v1/Activity/CreateOrUpdateActivityWithDefaultJot /api/v1/Activity/CreateOrUpdateAndSendEmail /api/v1/Activity/CreateActivityAndSendEMail /api/v1/Activity/SendEmail /api/v1/Activity/EmailLog /api/v1/Activity/Reply /api/v1/Activity/ReplyAll /api/v1/Activity/Forward /api/v1/Activity/GetLatestTimelines /api/v1/Activity/UpdateFullActivity /api/v1/Activity/TodayActivities /api/v1/Activity/MarkActivitiesAsDone /api/v1/Activity/LoadActiveContracts /api/v1/Activity/Templates /api/v1/Activity/HtmlPreview /api/v1/Activity/PrintHtml /api/v1/Activity/GetDownloadUrl /api/v1/Activity/GetPostDownloadUrl /api/v1/Activity/Archive /api/v1/Activity/AsDataProduct /api/v1/Activity/GetBoDeleteModes /api/v1/Activity/FreeFields /api/v1/Activity/GetHash /api/v1/Activity/PrintableFields /api/v1/Activity/Photo /api/v1/Activity/Recent /api/v1/Activity/GetSample
OData	/api/v1/Activity/Count /api/v1/Activity/SearchIds /api/v1/Activity/Search
Preview	/api/v1/Activity/Previews /api/v1/Activity/Preview
Swagger	/api/v1/Activity/GetDataProductSchema /api/v1/Activity/GetPolymorphicSchema /api/v1/Activity/GetPolymorphicStandardSchema /api/v1/Activity/GetStandardSchema /api/v1/Activity/GetSwagger

GET: /api/v1/Activity/

Routing template:

/api/{version}/Activity/

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	ActivityPrintableRequest	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	Type	Required	In	Features
userId	integer	NO	Query	Format: int64
maxElements	integer	NO	Query	Format: int64
futureDays	integer	NO	Query	Format: int64

Name	Description
AccountAccessLevel	Account Access Level
ActiveModules	Active Modules
ActivityBO	Activity BO
ActivityBOHourBandDTO	Activity BO Hour Band
ActivityCostBOPriceDetailDTO	Activity Cost BO Price Detail
ActivityDTO	Activity
ActivityEMailDataDTO	Activity EMail Data
ActivityFaxDataDTO	Activity Fax Data
ActivityPrintableRequest	Activity Printable Request
ActivityPriorities	Activity Priorities
ActivitySource	Activity Source
ActivityStates	Activity States
ActivityType	Activity Type
AddressAccuracy	Address Accuracy
AlarmActionType	Alarm Action Type
AlarmDTO	Alarm
AlarmNotificationDTO	Alarm Notification
AlarmTimeValueType	Alarm Time Value Type
ApprovedStatus	Approved Status
BoDeleteMode	Bo Delete Mode
BusinessObjectInvoker	Business Object Invoker
BusinessObjectLoadedType	Business Object Loaded Type
BusinessObjectType	Business Object Type
Calendar	Calendar
CatalogPriceListUsage	Catalog Price List Usage
CatalogType	Catalog Type
ConsumptionType	Consumption Type
ContractServicesStatus	Contract Services Status
CreateActivityAndDefaultJotRequest	Create Activity And Default Jot Request
CRMTables	CRM Tables
CrossActivityWith	Cross Activity With
DefaultCodeType	Default Code Type
DefaultDocumentCategories	Default Document Categories
DeleteItemResult	Delete Item Result
ExistsItemResult	Exists Item Result
ExternalReferenceDTO	External Reference
FileCrossAttributes	File Cross Attributes
FileCrossTypes	File Cross Types
FilePreview	File Preview
FlowLinkDTO	Flow Link
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
IActivityCrossRolling	Activity Cross Rolling
IActivityEMailData	Activity EMail Data
IActivityFaxData	Activity Fax Data
IActivityRelation	Activity Relation
IAlarmBO	Alarm BO
IAlarmNotification	Alarm Notification
ICatalogAlternativeUnitBO	Catalog Alternative Unit BO
ICatalogBO	Catalog BO
ICatalogProductPriceBO	Catalog Product Price BO
IContractBillingRangeLock	Contract Billing Range Lock
IContractBO	Contract BO
IContractConsumptionConfig	Contract Consumption Config
IContractJobOrderTaskPlanned	Contract Job Order Task Planned
IContractJobOrderTaskPlannedActivityBO	Contract Job Order Task Planned Activity BO
IContractRenewalsBO	Contract Renewals BO
IContractSections	Contract Sections
IContractTypeOfServiceBO	Contract Type Of Service BO
ICrmBusinessObjects	Crm Business Objects
IDirection	Direction
IExternalReference	External Reference
IFileCross	File Cross
IFreeFieldItemLocalizing	Free Field Item Localizing
IFreeFieldsItem	Free Fields Item
IGeo	Geo
IHourBand	Hour Band
ILocalizing	Localizing
ILocation	Location
IMailAddress	Mail Address
IPriceDetail	Price Detail
IPrintTemplate	Print Template
IPrivacyActivityMotivationImplicitConsentBO	Privacy Activity Motivation Implicit Consent BO
IQueryFragment	Query Fragment
IQueryMutators	Query Mutators
IQueryPaging	Query Paging
IRollingStockInContractBO	Rolling Stock In Contract BO
IServiceFixedMonthToInvoice	Service Fixed Month To Invoice
ISharePermission	Share Permission
ISharing	Sharing
ISimpleCatalogLink	Simple Catalog Link
IStorageBO	Storage BO
ITreeItem	Tree Item
IUserConfig	User Config
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
LoggedStatus	Logged Status
LoginResult	Login Result
MailAddressDTO	Mail Address
MapExternalReferenceRequest	Map External Reference Request
MessageCode	Message Code
MultipleDeleteModel	Multiple Delete Model
MultipleExistsModel	Multiple Exists Model
MultipleGetModel	Multiple Get Model
OperationMachineType	Operation Machine Type
PrintHtmlRequest	Print Html Request
PrintTemplateDTO	Print Template
PrivacyActivityMotivationImplicitConsentDTO	Privacy Activity Motivation Implicit Consent
QueryFragmentKind	Query Fragment Kind
RecentRouteType	Recent Route Type
SampleGenerationStrategy	Sample Generation Strategy
StandardSchemaVersion	Standard Schema Version
StoragePermission	Storage Permission
SubAccountType	Sub Account Type
Template	Template
ToDoStates	To Do States
TypeOfContractSection	Type Of Contract Section
TypeOfInstalment	Type Of Instalment
TypeOfPrice	Type Of Price
TypeOfSection	Type Of Section
TypeOfService	Type Of Service
YearMode	Year Mode

APIv1italianoActivity

Activity

Sicurezza

Note

Aliases

Authentication

Token JWT

Bearer Authentication

Identificazione dell’applicazione chiamante

Actions & Paths

GET: /api/v1/Activity/

Routing template:

Produces:

Response: 200 (Success) ApiActionResult

Samples

Provalo !

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

Parameters:

Produces:

Response: 200 (Success) Boolean

Samples

Provalo !

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

Parameters:

Produces:

Response: 200 (Success) ActivityDTO

Samples

Provalo !

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

Parameters:

Produces:

Response: 400 (Bad Request) integer

Samples

Provalo !

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

Parameters:

Produces:

Response: 200 (Success) ActivityDTO

Samples

Provalo !

GET: /api/v1/Activity/{id}/EmailLog

Parameters:

Produces:

Response: 400 (Bad Request) string

Samples

Provalo !

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

Parameters:

Produces:

Response: 200 (Success) Boolean

Samples

Provalo !

POST: /api/v1/Activity/{id}/Forward

Parameters:

Produces:

Response: 400 (Bad Request) ActivityDTO

Samples

Provalo !

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

Parameters:

Produces:

Response: 200 (Success) FreeFieldsBOItemDTO

Samples

Provalo !

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

Parameters:

Produces:

Response: 400 (Bad Request) string

Samples

Provalo !

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

Parameters:

Produces:

Response: 200 (Success) ActivityDTO

Samples

Provalo !

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

Parameters:

Produces:

Response: 200 (Success) String

API v1 italiano Activity