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.

AliasPath
PrivacyTypesManagements/api/v1/PrivacyTypesManagements
PrivacyTypeManagement/api/v1/PrivacyTypeManagement

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 nameMost commonly used actions
CRUD
Multiple CRUD
External References
Misc
OData
Swagger

GET: /api/v1/PrivacyTypeManagement/

Routing template:

/api/{version}/PrivacyTypeManagement/

Tags:

  • PrivacyTypeManagement

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

Response: 200 (Success) ApiActionResult

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

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

Parameters:

NameTypeRequiredInFeatures
id integer YES Path
  • Format: int64

Tags:

  • PrivacyTypeManagement

Produces:

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

Response: 200 (Success) Boolean

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

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

Parameters:

NameTypeRequiredInFeatures
id integer YES Path
  • Format: int64

Tags:

  • PrivacyTypeManagement

Produces:

Response: 200 (Success) PrivacyTypeManagementDTO

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

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

Parameters:

NameTypeRequiredInFeatures
id integer YES Path
  • Format: int64

Tags:

  • PrivacyTypeManagement

Produces:

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

Response: 200 (Success) Boolean

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

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

Parameters:

NameTypeRequiredInFeatures
id integer YES Path
  • Format: int64

Tags:

  • PrivacyTypeManagement

Produces:

Response: 200 (Success) FreeFieldsBOItemDTO

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

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

Parameters:

NameTypeRequiredInFeatures
id integer YES Path
  • Format: int64

Tags:

  • PrivacyTypeManagement

Produces:

Response: 200 (Success) PrivacyTypeManagementDTO

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

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

Parameters:

NameTypeRequiredInFeatures
id integer YES Path
  • Format: int64

Tags:

  • PrivacyTypeManagement

Produces:

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

Response: 200 (Success) String

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

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

Parameters:

NameTypeRequiredInFeatures
id integer YES Path
  • Format: int64

Tags:

  • PrivacyTypeManagement

Produces:

Response: 200 (Success) PrivacyTypeManagementDTO

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

DELETE: /api/v1/PrivacyTypeManagement/{id}/Photo

Parameters:

NameTypeRequiredInFeatures
id integer YES Path
  • Format: int64

Tags:

  • PrivacyTypeManagement

Response:

200 (Success)

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/{id}/Photo

Parameters:

NameTypeRequiredInFeatures
id integer YES Path
  • Format: int64

Tags:

  • PrivacyTypeManagement

Response:

200 (Success)

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

POST: /api/v1/PrivacyTypeManagement/{id}/Photo

Parameters:

NameTypeRequiredInFeatures
id integer YES Path
  • Format: int64

Tags:

  • PrivacyTypeManagement

Consumes:

  • multipart/form-data

Response:

200 (Success)

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

PUT: /api/v1/PrivacyTypeManagement/{id}/Recent

Parameters:

NameTypeRequiredInFeatures
id integer YES Path
  • Format: int64

Tags:

  • PrivacyTypeManagement

Produces:

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

Response: 200 (Success) Boolean

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/Count

Parameters:

NameTypeRequiredInFeatures
filter string NO Query

Tags:

  • PrivacyTypeManagement

Produces:

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

Response: 200 (Success) Int32

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

POST: /api/v1/PrivacyTypeManagement/CreateOrUpdate

Routing template:

/api/{version}/PrivacyTypeManagement/CreateOrUpdate

Tags:

  • PrivacyTypeManagement

Consumes:

  • application/json
  • application/xml
  • text/plain
  • application/json-patch+json
  • text/json
  • application/*+json

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

Response: 200 (Success) ApiActionResult

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

DELETE: /api/v1/PrivacyTypeManagement/DeleteByExternalReference

Parameters:

NameTypeRequiredInFeatures
externalReference string NO Query

Tags:

  • PrivacyTypeManagement

Produces:

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

Response: 200 (Success) Boolean

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/DeleteByExternalReference

Parameters:

NameTypeRequiredInFeatures
externalReference string NO Query

Tags:

  • PrivacyTypeManagement

Produces:

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

Response: 200 (Success) Boolean

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/GetBoDeleteModes

Routing template:

/api/{version}/PrivacyTypeManagement/GetBoDeleteModes

Tags:

  • PrivacyTypeManagement

Produces:

Response: 200 (Success) array of BoDeleteMode

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/GetByExternalReference

Parameters:

NameTypeRequiredInFeatures
externalReference string NO Query

Tags:

  • PrivacyTypeManagement

Produces:

Response: 200 (Success) PrivacyTypeManagementDTO

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/GetIdsByExternalReference

Parameters:

NameTypeRequiredInFeatures
externalReference string NO Query
excludeDeletedItems boolean NO Query

Tags:

  • PrivacyTypeManagement

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

Response: 200 (Success) Int64

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

POST: /api/v1/PrivacyTypeManagement/GetIdsMappedByExternalReference

Routing template:

/api/{version}/PrivacyTypeManagement/GetIdsMappedByExternalReference

Tags:

  • PrivacyTypeManagement

Consumes:

  • application/json
  • application/xml
  • text/plain
  • application/json-patch+json
  • text/json
  • application/*+json
  • text/xml
  • application/*+xml

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

Response: 200 (Success) ApiActionResult

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

POST: /api/v1/PrivacyTypeManagement/GetIdsNotMappedByExternalReference

Routing template:

/api/{version}/PrivacyTypeManagement/GetIdsNotMappedByExternalReference

Tags:

  • PrivacyTypeManagement

Consumes:

  • application/json
  • application/xml
  • text/plain
  • application/json-patch+json
  • text/json
  • application/*+json
  • text/xml
  • application/*+xml

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

Response: 200 (Success) ApiActionResult

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

POST: /api/v1/PrivacyTypeManagement/GetItemsMappedByExternalReference

Routing template:

/api/{version}/PrivacyTypeManagement/GetItemsMappedByExternalReference

Tags:

  • PrivacyTypeManagement

Consumes:

  • application/json
  • application/xml
  • text/plain
  • application/json-patch+json
  • text/json
  • application/*+json
  • text/xml
  • application/*+xml

Produces:

Response: 200 (Success) ApiActionResult

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

POST: /api/v1/PrivacyTypeManagement/GetItemsNotMappedByExternalReference

Routing template:

/api/{version}/PrivacyTypeManagement/GetItemsNotMappedByExternalReference

Tags:

  • PrivacyTypeManagement

Consumes:

  • application/json
  • application/xml
  • text/plain
  • application/json-patch+json
  • text/json
  • application/*+json
  • text/xml
  • application/*+xml

Produces:

Response: 200 (Success) ApiActionResult

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/GetNewInstance

Routing template:

/api/{version}/PrivacyTypeManagement/GetNewInstance

Tags:

  • PrivacyTypeManagement

Produces:

Response: 200 (Success) PrivacyTypeManagementDTO

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/GetPolymorphicSchema

Parameters:

NameTypeRequiredInFeatures
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

Tags:

  • PrivacyTypeManagement

Produces:

  • HTTP 400: object as application/json
  • HTTP 400: object as text/json
  • HTTP 400: object as application/xml
  • HTTP 400: object as text/plain
  • HTTP 400: object as application/octet-stream

Response: 400 (Bad Request) object

Samples

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/GetSample

Parameters:

NameTypeRequiredInFeatures
force boolean NO Query
  • Default: False
sampleGenerationStrategy SampleGenerationStrategy NO Query
useExtensions boolean NO Query
  • Default: True

Tags:

  • PrivacyTypeManagement

Produces:

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

Response: 200 (Success) JObject

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/GetStandardSchema

Parameters:

NameTypeRequiredInFeatures
honorAcceptLanguageHeader boolean NO Query
  • Default: False

Tags:

  • PrivacyTypeManagement

Produces:

  • HTTP 400: object as application/json
  • HTTP 400: object as text/json
  • HTTP 400: object as application/xml
  • HTTP 400: object as text/plain
  • HTTP 400: object as application/octet-stream

Response: 400 (Bad Request) object

Samples

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/GetSwagger

Parameters:

NameTypeRequiredInFeatures
honorAcceptLanguageHeader boolean NO Query
  • Default: False
bestPracticeOnly boolean NO Query
  • Default: True

Tags:

  • PrivacyTypeManagement

Produces:

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

Response: 200 (Success) object

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/MapByExternalReference

Parameters:

NameTypeRequiredInFeatures
externalReference string NO Query
internalItemId integer NO Query
  • Format: int64

Tags:

  • PrivacyTypeManagement

Response:

200 (Success)

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

DELETE: /api/v1/PrivacyTypeManagement/MultipleDelete

Routing template:

/api/{version}/PrivacyTypeManagement/MultipleDelete

Tags:

  • PrivacyTypeManagement

Consumes:

  • application/json
  • application/xml
  • text/plain
  • application/json-patch+json
  • text/json
  • application/*+json
  • text/xml
  • application/*+xml

Produces:

Response: 200 (Success) ApiActionResult

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

POST: /api/v1/PrivacyTypeManagement/MultipleDelete

Routing template:

/api/{version}/PrivacyTypeManagement/MultipleDelete

Tags:

  • PrivacyTypeManagement

Consumes:

  • application/json
  • application/xml
  • text/plain
  • application/json-patch+json
  • text/json
  • application/*+json
  • text/xml
  • application/*+xml

Produces:

Response: 200 (Success) ApiActionResult

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

POST: /api/v1/PrivacyTypeManagement/MultipleExists

Routing template:

/api/{version}/PrivacyTypeManagement/MultipleExists

Tags:

  • PrivacyTypeManagement

Consumes:

  • application/json
  • application/xml
  • text/plain
  • application/json-patch+json
  • text/json
  • application/*+json
  • text/xml
  • application/*+xml

Produces:

Response: 200 (Success) ApiActionResult

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

POST: /api/v1/PrivacyTypeManagement/MultipleGet

Routing template:

/api/{version}/PrivacyTypeManagement/MultipleGet

Tags:

  • PrivacyTypeManagement

Consumes:

  • application/json
  • application/xml
  • text/plain
  • application/json-patch+json
  • text/json
  • application/*+json
  • text/xml
  • application/*+xml

Produces:

Response: 200 (Success) ApiActionResult[]>

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/PrintableFields

Parameters:

NameTypeRequiredInFeatures
includeFull boolean NO Query
  • Default: True
includeNesting boolean NO Query
  • Default: True

Tags:

  • PrivacyTypeManagement

Produces:

Response: 400 (Bad Request) array of LiquidStruct

Samples

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/ResetExternalReferences

Parameters:

NameTypeRequiredInFeatures
internalItemId integer NO Query
  • Format: int64

Tags:

  • PrivacyTypeManagement

Response:

200 (Success)

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/Search

Parameters:

NameTypeRequiredInFeatures
filter string NO Query
orderBy string NO Query
skip integer NO Query
  • Format: int64
top integer NO Query
  • Format: int64
select string NO Query

Tags:

  • PrivacyTypeManagement

Produces:

Response: 200 (Success) PrivacyTypeManagementDTO

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/SearchIds

Parameters:

NameTypeRequiredInFeatures
filter string NO Query
orderBy string NO Query
skip integer NO Query
  • Format: int64
top integer NO Query
  • Format: int64

Tags:

  • PrivacyTypeManagement

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

Response: 200 (Success) Int64

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/SearchIdsByExternalReference

Parameters:

NameTypeRequiredInFeatures
externalReference string NO Query

Tags:

  • PrivacyTypeManagement

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

Response: 200 (Success) Int64

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

GET: /api/v1/PrivacyTypeManagement/UnmapByExternalReference

Parameters:

NameTypeRequiredInFeatures
externalReference string NO Query
internalItemId integer NO Query
  • Format: int64

Tags:

  • PrivacyTypeManagement

Response:

200 (Success)

Samples

Download HTTP 200 response sample

Download Postman collection sample

Try this !

Definitions

The following definitions describe the structure of the datamodels involved in the various REST operations that can be performed for this controller.

Some definitions are subjected to polymorphic serialization, and therefore their complete polymorphic scheme is reported.

NameDescription
BoDeleteModeBo Delete Mode
BusinessObjectTypeBusiness Object Type
CRMTablesCRM Tables
DeleteItemResultDelete Item Result
DTOPropertyUsageDTO Property Usage
ExistsItemResultExists Item Result
ExternalReferenceDTOExternal Reference
FreeFieldsBOItemDTOFree Fields BO Item
FreeFieldsBOItemLocalizingDTOFree Fields BO Item Localizing
FreeFieldsBOTreeItemDTOFree Fields BO Tree Item
FreeFieldsTypeFree Fields Type
GetIdsMappedByExternalReferenceRequestGet Ids Mapped By External Reference Request
GetItemResult`1[]Get Item Result`1
GetItemsMappedByExternalReferenceRequestGet Items Mapped By External Reference Request
GravityGravity
JTokenJ Token
LinkItemLink Item
LiquidStructLiquid Struct
LocalizeTypeLocalize Type
LocalizingDTOLocalizing
MultipleDeleteModelMultiple Delete Model
MultipleExistsModelMultiple Exists Model
MultipleGetModelMultiple Get Model
PrivacyTypeManagementDTOPrivacy Type Management
SampleGenerationStrategySample Generation Strategy
TypePrivacyType Privacy

Errors

The controller actions will generate errors for the following cases:

  • Status 400: Badly formed queries e.g. filter parameters that are not correctly encoded
  • Status 401: Authentication failures e.g. unrecognised keys
  • Status 403: Forbidden. The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort.
  • Status 404: Not found. Unknown resources e.g. data which is not public
  • Status 409: Conflict. Indicates that the request could not be processed because of conflict in the current state of the resource, such as an edit conflict between multiple simultaneous updates.
  • Status 500: Server errors e.g. where something has gone

Errors are formatted in JSON

Versioning

It is possible to select the web services version using the {version} token

/api/{version}/{controller}/{details}/{action}/{id}?{querystring}

The token {version} can contain both "exact" values ​​and the special "latest" alias, which identifies the most recent version among those existing in the system.

In general, the use of the special "latest" alias is strongly recommended.

If you want to be particularly "conservative" and adherent to a specific version, specify the name explicitly (eg "v1").

Routing

The system use the following routing syntax, consisting of a sequence of "path-tokens" (the request parameters):

{schema}://{host}/api/{version}/{controller}/{details}/{action}/{id}?{querystring}

The tokens identify respectively:

  • {host} -> HOST of the URL
  • {version} -> version of web services
  • {controller} -> name of the service (controller) you want to invoke
  • {details} -> optional detail level of the returned JSON (if applicable)
  • {action} -> optional action (method) invoked in the controller
  • {id} -> single optional primary key argument (parameter) of the method in the controller, if it so requires
  • {querystring} -> additional parameters and possible "modifiers" of the processing and serialization process

OData

The REST APIs are internally based on the Microsoft WebAPI technology, and are largely compliant with the REST specifications, OData v3 and OData v4.

Functions and details related to OData

For more details and specifications regarding the general criteria to adopt when using the OData functions, refer to the basic guide on the topic

Options

The REST API functions implemented in CRM in Cloud include a vast set of options that allow you to adapt the structure and shape of JSON packages according to your needs and preferences.

Unlike the parameters, which are specified in the URL route (through tokens and querystring), the options must instead be passed through the HTTP headers of the request.

As from RFC6648 all the options passed through HTTP headers have in their name the custom prefix "Crm-".

If a certain option is not specified, the system will use the default value specific to the {version} indicated in the URL.

For a complete discussion of options and polymorphic serialization, refer to the general guide on the subject

Swagger

Below you can download the JSON descriptor in Swagger/OpenAPI format

Download Swagger descriptor