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
JobOrders	/api/v1/JobOrders
JobOrder	/api/v1/JobOrder

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/JobOrder/CreateOrUpdate /api/v1/JobOrder/ /api/v1/JobOrder/Exists /api/v1/JobOrder/ /api/v1/JobOrder/Humanize /api/v1/JobOrder/GetFull /api/v1/JobOrder/GetNewInstance
Multiple CRUD	/api/v1/JobOrder/MultipleDelete /api/v1/JobOrder/MultipleExists /api/v1/JobOrder/MultipleGet
External References	/api/v1/JobOrder/SearchIdsByExternalReference /api/v1/JobOrder/GetByExternalReference /api/v1/JobOrder/DeleteByExternalReference /api/v1/JobOrder/MapByExternalReference /api/v1/JobOrder/ResetExternalReferences /api/v1/JobOrder/UnmapByExternalReference /api/v1/JobOrder/GetIdsMappedByExternalReference /api/v1/JobOrder/GetItemsMappedByExternalReference /api/v1/JobOrder/GetIdsNotMappedByExternalReference /api/v1/JobOrder/GetIdsByExternalReference /api/v1/JobOrder/GetItemsNotMappedByExternalReference
Misc	/api/v1/JobOrder/GetRelatedJobOrderTasks /api/v1/JobOrder/Templates /api/v1/JobOrder/HtmlPreview /api/v1/JobOrder/PrintHtml /api/v1/JobOrder/GetDownloadUrl /api/v1/JobOrder/GetPostDownloadUrl /api/v1/JobOrder/Archive /api/v1/JobOrder/AsDataProduct /api/v1/JobOrder/GetBoDeleteModes /api/v1/JobOrder/FreeFields /api/v1/JobOrder/GetHash /api/v1/JobOrder/PrintableFields /api/v1/JobOrder/Photo /api/v1/JobOrder/Recent /api/v1/JobOrder/GetSample
OData	/api/v1/JobOrder/Count /api/v1/JobOrder/SearchIds /api/v1/JobOrder/Search
Preview	/api/v1/JobOrder/Previews /api/v1/JobOrder/Preview
Swagger	/api/v1/JobOrder/GetDataProductSchema /api/v1/JobOrder/GetPolymorphicSchema /api/v1/JobOrder/GetPolymorphicStandardSchema /api/v1/JobOrder/GetStandardSchema /api/v1/JobOrder/GetSwagger

GET: /api/v1/JobOrder/

Routing template:

/api/{version}/JobOrder/

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	JobOrderPrintableRequest	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
AccountAccessLevel	Account Access Level
AccountStatus	Account Status
ActiveModules	Active Modules
ActivityPriorities	Activity Priorities
ActivitySource	Activity Source
ActivityStates	Activity States
ActivityType	Activity Type
AddressAccuracy	Address Accuracy
AddressDTO	Address
AlarmActionType	Alarm Action Type
AlarmTimeValueType	Alarm Time Value Type
AnagraphicStatus	Anagraphic Status
ApprovalPendingStatus	Approval Pending Status
ApprovalRuleCalcType	Approval Rule Calc Type
ApprovedStatus	Approved Status
BoDeleteMode	Bo Delete Mode
Boolean	Boolean
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
CRMTables	CRM Tables
CrossActivityWith	Cross Activity With
CrossType	Cross Type
DefaultCodeType	Default Code Type
DefaultDocumentCategories	Default Document Categories
DeleteItemResult	Delete Item Result
DirectionDTO	Direction
EMailNormalizedDTO	EMail Normalized
EMailNormalizeType	EMail Normalize Type
ErpDocumentStatus	Erp Document Status
ErpGroupingType	Erp Grouping Type
ERPRowType	ERP Row Type
ExistsItemResult	Exists Item Result
ExternalReferenceDTO	External Reference
FileCrossAttributes	File Cross Attributes
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
Gender	Gender
GeoDTO	Geo
GetIdsMappedByExternalReferenceRequest	Get Ids Mapped By External Reference Request
GetItemResult`1[]	Get Item Result`1
GetItemsMappedByExternalReferenceRequest	Get Items Mapped By External Reference Request
Gravity	Gravity
IAccount_Skill	Account_Skill
IAccountBO	Account BO
IAccountTierAccessPermit	Account Tier Access Permit
IActivityBO	Activity BO
IActivityCrossRolling	Activity Cross Rolling
IActivityEMailData	Activity EMail Data
IActivityFaxData	Activity Fax Data
IActivityRelation	Activity Relation
IAddressBO	Address BO
IAddresses	Addresses
IAlarmBO	Alarm BO
IAlarmNotification	Alarm Notification
IAnagraphicBO	Anagraphic BO
IApprovalPendingBO	Approval Pending BO
IApprovalResult	Approval Result
IAssetBO	Asset BO
ICatalogAlternativeUnitBO	Catalog Alternative Unit BO
ICatalogBO	Catalog BO
ICatalogProductPriceBO	Catalog Product Price BO
ICheckListBO	Check List BO
IContactBO	Contact BO
IContactOtherCompany	Contact Other Company
ICrmBusinessObjects	Crm Business Objects
IDDTBO	DDTBO
IDirection	Direction
IDocumentReference	Document Reference
IEMailNormalized	EMail Normalized
IERPRow	ERP Row
IERPRowExtension	ERP Row Extension
IERPRowGrouping	ERP Row Grouping
IERPRowGroupingExtension	ERP Row Grouping Extension
IExternalReference	External Reference
IFileCross	File Cross
IFlattenDetail	Flatten Detail
IFlattenRowDetail	Flatten Row Detail
IFreeFieldItemLocalizing	Free Field Item Localizing
IFreeFieldsItem	Free Fields Item
IGeo	Geo
IHourBand	Hour Band
IInvoiceBO	Invoice BO
IJobOrderTaskBO	Job Order Task BO
IJobOrderTaskResource	Job Order Task Resource
IJobOrderTaskSparePartBO	Job Order Task Spare Part BO
IListMailingListRights	List Mailing List Rights
ILocalizing	Localizing
ILocation	Location
IMailAddress	Mail Address
IMailingListRights	Mailing List Rights
IMovementRows	Movement Rows
IMySharePermission	My Share Permission
InfluencerRoleType	Influencer Role Type
INormalizeAddress	Normalize Address
INormalizeCity	Normalize City
InvoiceShip	Invoice Ship
InvoiceType	Invoice Type
IOpportunityBO	Opportunity BO
IOpportunityCompetitor	Opportunity Competitor
IOpportunityPartner	Opportunity Partner
IOpportunityProduct	Opportunity Product
IOpportunityReferrer	Opportunity Referrer
IOrderBO	Order BO
IPaymentMovementsBO	Payment Movements BO
IPhoneNormalized	Phone Normalized
IPriceDetail	Price Detail
IPrintTemplate	Print Template
IPrivacyActivityMotivationImplicitConsentBO	Privacy Activity Motivation Implicit Consent BO
IPrivacyManagementBO	Privacy Management BO
IPrivacyTypeManagementBO	Privacy Type Management BO
IQueryFragment	Query Fragment
IQueryMutators	Query Mutators
IQueryPaging	Query Paging
IQuoteBO	Quote BO
IRelation	Relation
ISharePermission	Share Permission
ISharing	Sharing
ISimpleCatalogLink	Simple Catalog Link
IStorageBO	Storage BO
ITaxSummary	Tax Summary
ITicketActionBO	Ticket Action BO
ITicketAttach	Ticket Attach
ITicketBO	Ticket BO
ITreeItem	Tree Item
ITriggerableFlowBusinessObject	Triggerable Flow Business Object
IUserConfig	User Config
IWebApiKey	Web Api Key
IWebApiKeyDomain	Web Api Key Domain
JobOrderBillingType	Job Order Billing Type
JobOrderConsumptionConfigDTO	Job Order Consumption Config
JobOrderDTO	Job Order
JobOrderPrintableRequest	Job Order Printable Request
JobOrderResourceDTO	Job Order Resource
JobOrderRollOperation	Job Order Roll Operation
JobOrderSparePart	Job Order Spare Part
JobOrderTaskMode	Job Order Task Mode
JotSparePartOperationType	Jot Spare Part Operation Type
LinkItem	Link Item
LiquidStruct	Liquid Struct
LocalizeType	Localize Type
LocalizingDTO	Localizing
LocationDTO	Location
LoggedStatus	Logged Status
LoginResult	Login Result
MapExternalReferenceRequest	Map External Reference Request
MessageCode	Message Code
MultipleDeleteModel	Multiple Delete Model
MultipleExistsModel	Multiple Exists Model
MultipleGetModel	Multiple Get Model
NormalizerNormalizeAddressDTO	Normalizer Normalize Address
NormalizerNormalizeCityDTO	Normalizer Normalize City
NotifyAppointmentMode	Notify Appointment Mode
ObjectPolicy	Object Policy
OpportunityRefStatusType	Opportunity Ref Status Type
OpportunityStatus	Opportunity Status
OrderStage	Order Stage
PhoneNormalizedDTO	Phone Normalized
PhoneNormalizeType	Phone Normalize Type
PolicyKind	Policy Kind
PrintHtmlRequest	Print Html Request
PrintTemplateDTO	Print Template
QueryFragmentKind	Query Fragment Kind
QuoteStage	Quote Stage
RecentRouteType	Recent Route Type
RowContentType	Row Content Type
RowTypeGiftVatMode	Row Type Gift Vat Mode
SampleGenerationStrategy	Sample Generation Strategy
ServiceCrossType	Service Cross Type
SharePermissionDTO	Share Permission
SharingDTO	Sharing
ShippedBy	Shipped By
StandardSchemaVersion	Standard Schema Version
StoragePermission	Storage Permission
SubAccountType	Sub Account Type
SyncPropertyFlag	Sync Property Flag
Template	Template
TicketMessageType	Ticket Message Type
ToDoStates	To Do States
TypeOfService	Type Of Service
TypePrivacy	Type Privacy

APIv1EnglishJob Order

Job Order

Security

Note

Aliases

Authentication

JWT Token

Bearer Authentication

Identification of the calling application

Actions & Paths

GET: /api/v1/JobOrder/

Routing template:

Tags:

Produces:

Response: 200 (Success) ApiActionResult

Samples

Try this !

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

Parameters:

Tags:

Produces:

Response: 200 (Success) Boolean

Samples

Try this !

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

Parameters:

Tags:

Produces:

Response: 200 (Success) JobOrderDTO

Samples

Try this !

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

Parameters:

Tags:

Produces:

Response: 400 (Bad Request) integer

Samples

Try this !

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

Parameters:

Tags:

Produces:

Response: 200 (Success) JobOrderDTO

Samples

Try this !

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

Parameters:

Tags:

Produces:

Response: 200 (Success) Boolean

Samples

Try this !

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

Parameters:

Tags:

Produces:

Response: 200 (Success) FreeFieldsBOItemDTO

Samples

Try this !

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

Parameters:

Tags:

Produces:

Response: 400 (Bad Request) string

Samples

Try this !

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

Parameters:

Tags:

Produces:

Response: 200 (Success) JobOrderDTO

Samples

Try this !

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

Parameters:

Tags:

Produces:

Response: 200 (Success) String

Samples

Try this !

API v1 English Job Order