Märkus.
Juurdepääs sellele lehele nõuab autoriseerimist. Võite proovida sisse logida või kausta vahetada.
Juurdepääs sellele lehele nõuab autoriseerimist. Võite proovida kausta vahetada.
Väliteeninduse organisatsioonid peavad planeerima tööd, sageli teenuse agent kaudu otse kliendi poolt. Broneeringud luuakse tavaliselt ettevõtte käsutuses olevate ressursside ja töö nõuete põhjal.
Kui kasutad vähemalt Dynamics 365 Field Service v8.8.43.51 ja Universal Resource Scheduling v3.12.46.21 töö ajastamiseks, kasuta msdyn_SearchResourceAvailability API-d, et hankida kõik töö jaoks sobivad ressursid, et saaksid töö efektiivselt ajastada. Kirjutamise hetkel on v3 veebipõhise API kõnede uusim msdyn_SearchResourceAvailability versioon ja toetab neid.
Märkus.
Kasuta API uusimat versiooni, kuna vanemad versioonid võivad kasutada aegunud autentimismeetodeid.
Sisendparameetrid
| Nimi | Tüüp | Kirjeldus | Nõutav | Vaikesäte |
|---|---|---|---|---|
| Versioon | String | API versiooni number identifitseerib käivitatava API versiooni. See järgib vormingut major.minor.patch.
|
Nr | Praegune versioon |
| IsWebApi | loogiline | Seadista True , et kasutada ajastamise assistenti veebi API kaudu. | Jah | Puudub |
| Nõue | Üksus | See atribuut määrab ressursinõude, mille jaoks ressursi saadavust leitakse. Eeldatakse, et see on msdyn_resourcerequirement tüüpi olem. Nõue võib olla andmebaasist olemasolev kirje või see, mis on loodud lennult vajalike piirangutega. Olem peaks sisaldama kõiki teie otsingu jaoks olulisi konkreetseid andmeid. Selle üksuse @odata.type peaks olema Microsoft.Dynamics.CRM.msdyn_requirement. Järgmised mõned olulised atribuudid, mida asustada:
|
Jah | Puudub |
| Sätted | Üksus | Sätete atribuut aitab saadud ressursse veelgi filtreerida. Määra seaded atribuutidena entiteedikotis. Olemi tüüp pole oluline. Saate määrata mis tahes olemi loogilise nime. | Jah | Puudub |
| ResourceSpecification | Üksus | Määratle atribuut resourceSpecification kui atribuudid entiteedikotis. Selle üksuse @odata.type peaks olema Microsoft.Dynamics.CRM.expando. |
Nr | Pole |
Sätete olem
Sätete olem ei ole olem, mis on olemas Dataverse; kuid see on kõigi järgmiste atribuutide kogum, mis aitab ajastada Abimees API tulemusi filtreerida. Seega peaks selle üksuse @odata.type olema Microsoft.Dynamics.CRM.expando.
| Nimi | Tüüp | Kirjeldus | Nõutav | Vaikesäte |
|---|---|---|---|---|
| ConsiderSlotsWithLessThanRequiredCapacity | loogiline | Seadke see väärtusele Tõene , kui ressursi kalendris võimalike saadaolevate ajavahemike arvutamisel tuleks arvesse võtta nõutavast võimsusest (panusest) väiksemat ajavahemikku. | Nr | False |
| ConsiderSlotsWithLessThanRequiredDuration | loogiline | Seadke see väärtusele Tõene , kui ressursi kalendris võimalike saadaolevate ajavahemike arvutamisel tuleks arvesse võtta nõutavast kestusest väiksemat ajavahemikku. | Nr | False |
| ConsiderSlotsWithOverlappingBooking | loogiline | Seadke see väärtusele Tõene , kui ressursi kalendris võimalike saadaolevate ajavahemike arvutamisel tuleks arvesse võtta kattuvate broneeringutega ajavahemikku. | Nr | False |
| ConsiderSlotsWithProposedBookings | loogiline | Seadke see väärtusele Tõene , kui ressursi kalendris võimalike saadaolevate ajavahemike arvutamisel tuleks arvesse võtta pakutud broneeringutega ajavahemikku. | Nr | False |
| ConsiderAppointments | loogiline | Määrake selle väärtuseks Tõene otsinguressursside saadavuse API puhul, et austada olemasolevaid Dataverse kohtumisi ressursi broneeringutena, eeldusel, et organisatsiooni ja ressursitaseme sätted on määratud. Kohtumised, mille staatus on hõivatud või lõpetatud , loetakse operatsioonide ajastamiseks kättesaamatuks. | Nr | False |
| ConsiderTravelTime | loogiline | Seadke see väärtusele Tõene , kui ressursi kalendris võimalike ajavahemike arvutamisel tuleks arvestada reisiaega. | Nr | Tõene |
| ExcludeResourceCharacteristics | loogiline | Sea see väärtuseks Tõe , et välistada ressursi omadused ajavahemike jaoks vastuseks. | Nr | False |
| MovePastStartDateToCurrentDate | loogiline | Seadke see väärtusele Tõene , et teisaldada minevikus alguskuupäev praegusele kuupäevale. | Nr | False |
| UseRealTimeResourceLocation | loogiline | Seadke see väärtusele Tõene , kui ressursi kalendris võimalike ajavahemike arvutamisel tuleks kasutada ressursside reaalajas asukohta. | Nr | False |
| SortOrder | EntityCollection | Määrake sortimisjärjestus olemikogumi abil. Iga kogumi olem esindab ühte sortimiskriteeriumi ja saab sortida Resources ainult vastuse põhjal, kuid mitte TimeSlots. Selle üksuse @odata.type peaks olema Microsoft.Dynamics.CRM.expando. Järgmised on atribuudid, mida peate täitma.
|
Nr | Pole |
| MaxResourceTravelRadius | Üksus | See atribuut määrab maksimumi, mida saab olemis määratleda. Selle üksuse @odata.type peaks olema Microsoft.Dynamics.CRM.expando. Järgmised on atribuudid, mida peate täitma.
|
Nr | 0 km. Kui see on nii, siis kohapealsete nõuete jaoks ressursse ei tagastata. |
| MaxNumberOfResourcesToEvaluate | Täisarv | See atribuut määratleb taotluse jaoks arvestatavate ressursside arvu limiidi. | Nr | Kui see atribuut API kutses ei ole, kasutab süsteem Resource Availability Retrieval Limiti skeemitatava entiteedi definitsioonist, nagu on määratletud Edit seadetes lubatud entiteetide jaoks. Kui see on kaasatud kõnesse, kirjutab see üle määratletud ressursi kättesaadavuse toomise limiidi. |
| MõelgeOutlookSchedules | loogiline | Sea see True kui arvestada Outlook graafikuid. Saadaval ainult versioonides 3.1.0 ja uuemates. | Nr | False |
Ressursimääratluse olem
| Nimi | Tüüp | Kirjeldus | Nõutav | Vaikesäte |
|---|---|---|---|---|
| ResourceTypes | EntityCollection | See atribuut määratleb nõude jaoks vajaliku ressursi tüübi. Kasuta selle atribuudi määramiseks entiteedikogu. Iga kogumi olem tähistab ühte broneeritava ressursi tüüpi. Selle üksuse @odata.type peaks olema Microsoft.Dynamics.CRM.msdyn_resourceType. See atribuut on vajalik:
|
Nr | Kõik ressursitüübid, v.a meeskonnad |
| PreferredResources | EntityCollection | See atribuut määratleb nõude jaoks eelistatud ressursid. Lisa ressursse sellesse entiteetide kogusse, et need oleksid saadaval olevate ressursside nimekirja tipus. Isegi ressursid, mis ei kuulu entiteedikogu, on nimekirjas, kuid alles pärast eelistatud ressursse. | Nr | Pole |
| RestrictedResources | EntityCollection | See atribuut määrab ressursid, mida ei tohiks nõude puhul arvesse võtta. Kõik selle ressursi ajavahemikud filtreeritakse selle API tulemuste nimekirjast välja. | Nr | Pole |
| MustChooseFromResources | EntityCollection | See atribuut määrab ainsad ressursid, mis võivad olla saadaolevate ressursside loendis. See filtreerib väljundloendist välja kõik muud tulemused. | ||
| Piirangud | Üksus | See atribuut määrab täiendavad piirangud, mida tuleks rakendada saadaolevate ressursside toomisele. | Nr | Pole |
| RetrieveResourcesQueryId | GUID | Päringu Ressursid toomise ID. | Nr | Ressursipäringu vaike-ID. |
| BookedResourceId | GUID | See atribuut määratleb nõude jaoks praegu broneeritud ressursi. | Nr | Pole |
Märkus.
Kasuta broneeritavate ressursiüksuste kogumikku, et määrata Preferred, Restricted ja MustChooseFrom ressursside atribuudid. Iga kogu üksus esindab ühte Eelistatud, Piiratud või MustChooseFrom ressurssi. See omadus on neile vajalik:
-
Value (Guid): Eelistatud, piiratud või MustChooseFrom ressursi broneeritav ID. Selle üksuse
@odata.typepeaks olemaMicrosoft.Dynamics.CRM.msdyn_bookableresource.
Piirangud
Määra täiendavad piirangud selle entiteedi atribuutide kaudu. Olemi tüüp pole oluline. Saate määrata mis tahes olemi loogilise nime.
Vaadake ajastamistahvel sätetes üle päring Ressursside toomine, et teha kindlaks, millised piirangud võivad kehtida. Vaikimisi sisaldab see järgmist.
| Nimi | Tüüp | Kirjeldus |
|---|---|---|
| Tunnused | EntityCollection | Omaduste kogum, mida kvalifitseeritud ressursil peab olema. Iga kirje sisaldab a-d characteristic iseloomuliku ID-ga. Soovi korral lisa a ratingvalue koos hindamisväärtuse ID-ga, et filtreerida ressursse konkreetse pädevustaseme järgi. |
| Rollid | EntityCollection | Rolli ID-de kogum, mis kvalifitseeritud ressursil olema peab. |
| Piirkonnad | EntityCollection | Piirkonna ID-de kogum. Kvalifitseeritud ressurss peab olema määratud ühele piirkonnale. |
| UnspecifiedTerritory | loogiline | Määratleb kombinatsioonis piirkondade piirangutega, et kvalifitseeritud olek tuleb määrata ühele territooriumile või üldse mitte ühelegi. |
| OrganizationalUnits | EntityCollection | Organisatsiooniüksuse ID-de kogum. Kvalifitseeritud ressurss peab olema ühe määratud organisatsiooniüksuse liige. |
| Meeskonnad | EntityCollection | meeskonna ID-de kogum. Kvalifitseeritud ressurss peab kuuluma ühele meeskonnale (see tähendab, et ressursitüüp on süsteemikasutaja). |
| BusinessUnits | EntityCollection | Äriüksuse ID-de kogumik. Kvalifitseeritud ressurss peab kuuluma ühele äriüksusele (see tähendab, et ressurss on süsteemikasutaja). |
Väljundparameetrid
Kõrgeimal tasemel on väljundil järgmised neli parameetrit. Tulemused on esitatud olemikogumites ja olemites. Vastused ei pruugi sisaldada kõiki siin kirjeldatud atribuute nullväärtusena või NA-väärtusi ei jäeta vastus välja. Enne atribuudile juurdepääsu proovimist kontrollige alati atribuudi olemasolu.
| Nimi | Tüüp | Kirjeldus |
|---|---|---|
| TimeSlots | EntityCollection | Ajapesa tulemuste kogum. Lisateavet leiate jaotisest Ajapilu olem. |
| Ressursid | EntityCollection | Ressursitulemuste kogum. Ressursid on esitatud järgmiste atribuutidega olemite kogumina.
|
| Seostuvad | Üksus | Seotud ressursid tähistavad ressursse ja ressursside ajavahemikke, mis ei ole otseselt taotletud nõude jaoks kvalifitseeritud, kuid on omavahel seotud. Näiteks kui meeskonnaliige kvalifitseerib nõudele, võivad teised selle meeskonna liikmed olla seotud tulemused.
|
| Erandid | Üksus | See atribuut sisaldab teavet kõigi ilmnenud erandite kohta ja teavet selle kohta, kas ja kus ressursiotsingut kärbiti.
|
Ajapesade olem
| Nimi | Tüüp | Kirjeldus |
|---|---|---|
| ID | GUID | Ajapesa ainuidentifikaator |
| Tüüp | Täisarv | Selline ajavahemik. See võib olla üks järgmistest väärtustest:
|
| StartTime | DateTime | Ajapesa algusaeg. Kui nõude täitmiseks on reisimine, siis see aeg on reisi algusaeg. Kui mitte, siis see aeg on nõude algusaeg. |
| ArrivalTime | DateTime | Ajapesa saabumisaeg. Kui nõude täitmiseks on reisimine, siis see aeg on nõude algusaeg pärast reisi lõpetamist. Kui ei, siis on see sama, mis ajavahemiku algusaeg. |
| EndTime | DateTime | Ajapesa lõpuaeg. |
| Panus | Täisarv | Ressursi panus või võimsus nõude täitmiseks. |
| ResourceRequirement | EntityReference | Ressursinõue, mille jaoks ajapesad tuuakse. |
| Potentsiaal | loogiline | Loogiline väärtus, mis näitab, kas ajapesal on potentsiaali soovitud nõuet täita. |
| IsDuplicate | loogiline | Loogikaväärtus, mis näitab, kas ajapesa on duplikaat. |
| AllowOverlapping | loogiline | Loogikaväärtus, mis näitab, kas kattumine on lubatud. |
| Ressurss | Üksus | Ressurss, kuhu ajapesa kuulub. Lisateavet vaadake jaotisest Ajapilu ressurss. |
| Location | Üksus | Asukohal on kolm atribuuti:
|
| Reisimine | Üksus | See olem sisaldab reisiaja üksikasju ja ajapesa kauguse teavet. Atribuudid on järgmised:
|
| Edasi | Üksus | See olem sisaldab üksikasju reisiaja ja järgmise ajapesa broneeringu kauguse kohta.
|
| Saadavus | Üksus | Ajapesa üksikasjalik saadavuse teave. Seda üksust kasutatakse ajagruppide puhul.
|
| TimeGroup | Üksus | Ajarühma üksikasjad.
|
Näpunäide
Kui loote broneeringuid API abil, kasutage tabelis kirjeldatud Potentsiaali välja. Selle välja kasutamata jätmine võib põhjustada kattuvaid või sobimatuid broneeringuid.
Ajapesa ressurss
| Nimi | Tüüp | Kirjeldus |
|---|---|---|
| Ressurss | EntityReference | Broneeritava ressursi olemi viide. |
| ResourceGroup | EntityReference | Broneeritava ressursirühma olemi viide. |
| Äriüksus | EntityReference | Olemiviide äriüksusele. |
| OrganizationalUnit | EntityReference | Organisatsiooniüksuse olemi viide. |
| ResourceType | Täisarv | Ressursi tüüp. Võimalike väärtuste leidmiseks vaadake olemi BookableResource atribuuti ResourceType . |
| PoolId | GUID | Selle kogumi ID, mille liige ressurss ajavahemiku jooksul on. |
| CrewId | GUID | Meeskond ID, mille liige ressurss ajaperioodi jooksul on. |
| Tunnused | EntityCollection | Broneeritava ressursi tunnused. Kogumi iga olem sisaldab tunnustega olemeid ja hinnangu teavet.
|
| HasStartLocation | loogiline | Loogikaväärtus, mis näitab, kas ressursil on algasukoht. |
| HasEndLocation | loogiline | Loogikaväärtus, mis näitab, kas ressursil on lõppasukoht. |
| Meil | String | Ressursi meiliaadress. |
| Telefon | String | Ressursi telefoninumber. |
| ImagePath | String | Ressursi pildi tee. |
| KalendriID | GUID | Ressursi kalendri ID. |
Näited
Selles näites kasutad Schedule Assistant API versiooni 3, mis toetab veebipõhiseid API kõnesid, nõude, mille kestus on 60 minutit. Atribuuti settings kasutades filtreerid tulemusi. Lõpptulemuste puhul arvestatakse kahte ressursitüüpi: 1 ja 2 (teisisõnu üldine ja kontakt).
{
"Version": "4",
"IsWebApi": true,
"Requirement": {
"msdyn_fromdate": "2021-07-14T00:00:00Z",
"msdyn_todate": "2021-07-15T23:59:00Z",
"msdyn_remainingduration": 60,
"msdyn_duration": 60,
"msdyn_TimeGroup@odata.bind": "/msdyn_timegroups(c3dc79ea-d12f-ee11-9cc9-000d3a745a58)",
"@odata.type": "Microsoft.Dynamics.CRM.msdyn_resourcerequirement"
},
"Settings": {
"ConsiderSlotsWithProposedBookings": false,
"MovePastStartDateToCurrentDate": true,
"@odata.type": "Microsoft.Dynamics.CRM.expando"
},
"ResourceSpecification": {
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"ResourceTypes@odata.type": "Collection(Microsoft.Dynamics.CRM.expando)",
"ResourceTypes": [
{
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"value": "1"
},
{
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"value": "2"
}
],
"Constraints": {
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"Characteristics@odata.type": "Collection(Microsoft.Dynamics.CRM.expando)",
"Characteristics": [
{
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"characteristic": {
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"value": "67387f9f-12e2-ec11-bb43-000d3aed25f7"
},
"ratingvalue": {
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"value": "a1b2c3d4-5678-90ab-cdef-1234567890ab"
}
}
],
"Territories@odata.type": "Collection(Microsoft.Dynamics.CRM.expando)",
"Territories": [
{
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"value": "cc19f004-4483-ee11-8178-000d3a5c32c3"
}
],
"Roles@odata.type": "Collection(Microsoft.Dynamics.CRM.expando)",
"Roles": [
{
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"value": "76998e42-744c-f011-877d-6045bdfb899e"
}
]
}
}
}
Järgmine näide demonstreerib olemikogumite õiget kasutamist. Selles kontekstis määratletakse MustChooseFromResources.
{
"Version": "4",
"IsWebApi": true,
"Requirement": {
"msdyn_fromdate": "2021-07-14T00:00:00Z",
"msdyn_todate": "2021-07-15T23:59:00Z",
"msdyn_remainingduration": 60,
"msdyn_duration": 60,
"msdyn_latitude": 47.64807,
"msdyn_longitude": -122.41249,
"msdyn_worklocation": 690970000,
"msdyn_TimeGroup@odata.bind": "/msdyn_timegroups(c3dc79ea-d12f-ee11-9cc9-000d3a745a58)",
"@odata.type": "Microsoft.Dynamics.CRM.msdyn_resourcerequirement"
},
"Settings": {
"ConsiderSlotsWithProposedBookings": false,
"MovePastStartDateToCurrentDate": true,
"MaxNumberOfResourcesToEvaluate":500,
"ConsiderTravelTime": true,
"MaxResourceTravelRadius": {
"Value": 20,
"Unit" : 192350000,
"@odata.type": "Microsoft.Dynamics.CRM.expando"
},
"@odata.type": "Microsoft.Dynamics.CRM.expando"
},
"ResourceSpecification": {
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"ResourceTypes@odata.type": "Collection(Microsoft.Dynamics.CRM.expando)",
"ResourceTypes": [
{
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"value": "1"
},
{
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"value": "2"
}
],
"MustChooseFromResources@odata.type": "Collection(Microsoft.Dynamics.CRM.expando)",
"MustChooseFromResources": [
{
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"value": "2145a982-f718-ed11-b83e-0022482d79c8"
}
],
"Constraints": {
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"Characteristics@odata.type": "Collection(Microsoft.Dynamics.CRM.expando)",
"Characteristics": [
{
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"characteristic": {
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"value": "67387f9f-12e2-ec11-bb43-000d3aed25f7"
},
"ratingvalue": {
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"value": "a1b2c3d4-5678-90ab-cdef-1234567890ab"
}
}
],
"Territories@odata.type": "Collection(Microsoft.Dynamics.CRM.expando)",
"Territories": [
{
"@odata.type": "Microsoft.Dynamics.CRM.expando",
"value": "cc19f004-4483-ee11-8178-000d3a5c32c3"
}
]
}
}
}