Workflow API (aiemmin TASK API) on REST-rajapinta, joka noudattaa OpenAPI-määrityksiä. Rajapintaa voidaan käyttää sekä tilausten käsittely- että palvelu- ja vikailmoitusmoduulin tehtävissä, mutta siinä erotetaan toisistaan inTask- ja outTask-tehtävät (linkit johtavat Swagger UI -käyttöliittymään).
API hyödyntää Equitri-protokollaa kaikkien järjestelmien synkronoinnin varmistamiseksi . Tämä tarkoittaa, että jokaisen päivityksen yhteydessä suoritetaan ensin Indication-vaihe, jota seuraa Fetch-vaihe ja lopuksi Sync-vaihe. Tämä koskee sekä organisaation Gridsz lähettämiä päivityksiä Gridsz Gridsz organisaatiolle Gridsz päivityksiä. Lisätietoja ja havainnollinen selitys löytyvät Equitri-protokollan sivulta.
Jotta tätä sovellusliittymää (API) voidaan käyttää, organisaatiolla on oltava vähintään SystemID ja Endpoint. Tätä varten pyydämme sinua ilmoittamaan seuraavat tiedot support – tai vaihtoehtoisesti määrittämään ne itse hallintaportaalissa, jos olet sivuston järjestelmänvalvoja:
- Klusteri – osoittaa, mihin klustereihin (verkkoihin) tätä järjestelmää voidaan käyttää
- SystemID – organisaatiokohtainen yksilöllinen tunniste järjestelmän tunnistamista varten
- Päätepiste – päätepiste, johon kaikki API-kutsut on ohjattava
- Tunnus – organisaation antama tunnus ( Gridsz käyttää tätä Gridsz järjestelmän päätepistettä)
- Oletuspäätepiste
Huomaa lisäksi, että API:n käyttö edellyttää IP-osoitteiden sallimista. Ota yhteyttä Gridsz support IP-osoitteet voidaan lisätä sallittujen luetteloon kunkin ympäristön osalta.
inTask-sovellusliittymä
InTask-sovellusliittymä on tarkoitettu organisaatioille, jotka haluavat luoda tehtäviä. Tällaisia ovat esimerkiksi aktiiviset operaattorit, jotka luovat asennustilauksia, tai verkko-omistajat, jotka luovat POP-häiriöilmoituksia, ja niin edelleen.
Julkaisutiedot
| Versio | Julkaisupäivä | Huomautukset |
|---|---|---|
| 1.36.0 | 23.7.2026 | Uusi API-päätetapahtuma ”calculateRoutingRules” on lisätty. Gridsz sen osapuolen, jolle tehtävät reititetään annettujen tietojen perusteella (tämä ei luo mitään tilausta; tarkoituksena on ainoastaan määrittää reititystulos ennakoivasti ennen kuin tilausta luodaan). isPrivate-kenttä on poistettu tunnisteista. Kyseessä on vain dokumentaation päivitys, sillä kenttää ei ole koskaan toteutettu tunnisteiden InTask-API:ssa. Kenttä on edelleen käytettävissä OutTask-API:ssa (muuttumattomana). |
| 1.35.0 | 5.6.2026 | Muuta kentän Mose.Shared.Models.ActiveOperatorTask.deadlines.name enimmäispituutta arvosta 3–99 arvoon 3–50 ja poista pakollisuusattribuutti kentästä ActiveOperatorTaskSync.MainStatus, jotta se vastaa nykyistä toimintaa |
| 1.34.0 | 6. toukokuuta 2026 | Lisättiin uusi kenttä SolutionParty kenttiin FTU_CHANGE ja DAMAGE_REPORT (jo käytettävissä kentissä INCIDENT, QUOTE ja NETWORK_DISCREPANCY) |
| 1.33.0 | 30.4.2026 | Lisätty uusi kenttä requestorIsExecutor – käytetään, kun pyynnön esittäjä (AO) tarvitsee ohjata tehtävän itselleen |
| 1.32.0 | 13.3.2026 | Päivitä tuotantoversion URL-osoite muotoon api.task.gridsz.com |
| 1.30.0 | 22.1.2026 | Lisää yhteystiedot juurikohteeseen |
| 1.29.0 | 22.1.2026 | Kenttä assignedSolutionParty on lisätty tehtävän hakutoiminnon (GET) juuritasolle – Tämä kenttä kertoo, mille osapuolelle tämän tilauksen/tiketin yhteydessä suoritettava tehtävä (tehtäväjoukko) on osoitettu – Tämän kentän täyttää yksinomaanGridsz –Gridsz voi päivittää arvon, jos tilaus/tiketti osoitetaan uudelleen ActiveEquipmentEndpoint- ja ActiveEquipmentEndpointMulti-kenttien osalta rivikenttää ei enää vaadita – Koska riviä ei usein tarvita työn suorittamiseen, validointia on lievennetty – Lisäksi kenttä on nyt asetettu nollattavaksi |
| 1.28.1 | 1.8.2026 | Yhteyshenkilön skeemassa kenttiä lastName ja phoneNumber ei enää vaadita – Tämä mahdollistaa laajemman valikoiman yhteydenottotilanteita, joissa täydellisiä henkilötietoja ei ole saatavilla tai niitä ei tarvita – Yhteyshenkilön kohdalla ei ole enää pakollisia kenttiä – mitä tahansa kenttää voidaan täyttää ja päivittää, kun se on tarpeen ja mahdollista ObjektinnetworkDiscrepancyInfo onlisätty taskInfo-objektiin – Tämän avulla voidaan luoda uusi tehtävätyyppi NETWORK_DISCREPANCY – joka kuvaa (mahdollista) eroa hallinnon ja fyysisen todellisuuden välillä. Lisää uusi päätepiste tunnisteellataskSearch – Tätä päätepistettä voidaan käyttää tehtävien etsimiseen tietyn osoitteen tai yhteyden perusteella Muut pienet muutokset, jotka ovat jo käytössä: Lisää uusi päätepisteOAuth2:lletunnisteellaauthorization – Gridsz asteittain käyttöön OAuth2:n kaikilleGridsz – tästä tiedotetaan laajemmin myöhemmin – Tärkeää: olemassa olevat Bearer-tunnukset pysyvät voimassa niiden voimassaolon päättymiseen asti $-merkki hyväksytään nyt AddressCode-kentässä Virhekorjaus:Gridsz nyt oikein reasons[] -tiedot tilassa PROVIDED |
| 1.27.4 | 13.11.2025 | KenttäsendImpactNotification lisätäänincidentInfo-kohdan alle. – Tämä valinnainen boolean-tyyppinen kenttä ilmaisee, voiko Gridsz luoda IMPACT_NOTIFICATION-tehtävätyyppejä. – Oletusarvoisesti, jos serviceAffecting =false, niinsendImpactNotification =false, ja päinvastoin, jostrue. |
| 1.27.3 | 10.2.2025 | ObjektissalinkedTasksonnytkolme uutta kenttää:subStatus,addressCode jareasons [taulukko]. – Näiden lisätietojen tarkoituksena on tarjota lisätietoa liittyvien tehtävien tilasta |
| 1.27.2 | 10.2.2025 | KentännetworkTypeoletusarvoksi onnytasetettu”FIBER”. – Tämä koskee vain luotavia uusia tehtäviä, joille arvo asetetaan alun perin luomisen yhteydessä – Tämä ei vaikuta olemassa oleviin tehtäviin, jotka säilyttävät nykyisen networkType-arvonsa (vaikka se olisityhjä) |
| 1.27.1 | 3.4.2025 | Tehtiin muutoksia juuritasonlinkedTasks-kenttään. –taskType-kenttävalidoidaan nyt Enum-arvojen mukaisesti – Lisätty seuraavat kentät: mainStatus, planned, orgId Gridsz hyödyntää nyt myös linkedTasks-tehtäviä proaktiivisesti linkittämällä automaattisesti tehtäviä, jotka liittyvät toisiinsa, mutta eivät ole peräisin samasta tilauksesta tai tiketistä Esimerkiksi: jos INSTALL-tehtävä luodaan osoitteeseen, jolla on jo avoin FTU_CHANGE-tehtävä. Linkittämällä nämä tehtävät ja näyttämällä tärkeitä tietoja, kuten tilan, osapuolet saavat hyvän yleiskuvan |
| 1.27.0 | 20.3.2025 | Gridsz support nyt support . – Tämä tarkoittaa, että yhdellä tilauksella on mahdollista toimittaa useita kuituja, jotka kuuluvat samaan liittymään. Esimerkiksi luomalla INSTALL-tilauksen ja pyytämällä sekä kuitua 1 että kuitua 2. – support olemme lisänneet API:hin seuraavat uudet objektit:PoPMultiInfo/HASMultiInfo/ConnectionMultiInfo Nämä kentät täytetään vain, jos verkon omistaja tai aktiiviset operaattorit pyytävät tilauksessaan monikuituyhteyttä toimittamalla useita kuituja Tämä tarkoittaa, että suurimmalle osalle Gridsz ja -järjestelmistä näitä kenttiä ei koskaan täytetä! |
| 1.26.9 | 3.6.2025 | KenttäexternalCorrelationIdon lisätty juuritasolle. – Tämä kenttä voidaan täyttää uutta tilausta luotaessa – Kenttää ei voi päivittää – Kentän täyttäminen on vapaaehtoista – Pyynnön esittäjä voi täyttää kentän, jotta tehtävän voi yhdistää sisäisen järjestelmänsä tehtävään Gridsz |
outTask-sovellusliittymä
OutTask-sovellusliittymä on tarkoitettu organisaatioille, jotka saavat suoritettavakseen tehtäviä. Tällaisia voivat olla esimerkiksi alihankkijat, jotka saavat päivityspyyntöjä, tai verkonvalvontakeskukset (NOC), jotka tutkivat verkkohäiriöitä tarkemmin, jne.
Julkaisutiedot
| Versio | Julkaisupäivä | Huomautukset |
|---|---|---|
| 1.35.0 | 5.6.2026 | Muuta kentän Mose.Shared.Models.ActiveOperatorTask.deadlines.name enimmäispituutta arvosta 3–99 arvoon 3–50 ja poista pakollisuusattribuutti kentästä ActiveOperatorTaskSync.MainStatus, jotta se vastaa nykyistä toimintaa |
| 1.34.0 | 5. toukokuuta 2026 | Muuta taskInfo → hasInfo → afterConnect → (deliveredFTUType ja deliveredConnectionStatus) vaaditusta valinnaiseksi |
| 1.33.0 | 2.4.2026 | Lisää kenttä outTaskCount tehtäväjoukkoon |
| 1.31.0 | 5.3.2026 | – Lisää POP-tiedot tehtävän tietoihin osoitteessa – Päivitä tuotantoyhteysosoite osoitteeksi api.task.gridsz.com |
| 1.29.0 | 5.2.2026 | – Lisää yhteystiedot juurikohteeseen – Lisää koordinaatit afterConnect-tapahtumaan |
| 1.28.0 | 22.1.2026 | ActiveEquipmentEndpoint- ja ActiveEquipmentEndpointMulti-luokissa row-kenttä ei ole enää pakollinen – Koska row-kenttää ei usein tarvita tehtävän suorittamiseen, kelpoisuustarkistusta on lievennetty – Lisäksi kenttä on nyt määritetty nollattavaksi |
| 1.27.0 | 1.8.2025 | Yhteyshenkilön skeemassa kenttiä lastName ja phoneNumber ei enää vaadita – Tämä mahdollistaa laajemman valikoiman yhteydenottotilanteita, joissa täydellisiä henkilötietoja ei ole saatavilla tai niitä ei tarvita – Yhteyshenkilön kohdalla ei ole enää pakollisia kenttiä – mikä tahansa kenttä voidaan täyttää ja päivittää, kun se on tarpeen ja mahdollista ObjektinnetworkDiscrepancyInfo onlisätty taskInfo-objektiin – Tämän kautta voidaan vastaanottaa uusi tehtävätyyppi NETWORK_INCONSISTENCY – joka kuvaa (mahdollista) eroa hallinnon ja fyysisen todellisuuden välillä. KenttäcoaxPathDescription onlisätty TechnicalPath-kenttään – Gridsz täyttää tämän kentän COAX-tehtävien Gridsz saatavilla olevien tietojen perusteella Availability-kohdassa Muut pienet muutokset, jotka ovat jo käytössä: Lisää uusi päätepisteOAuth2:lle tunnisteenauthorizationalle – Gridsz OAuth2:n asteittain käyttöön kaikissa Gridsz – tästä tiedotetaan laajemmin myöhemmin – Tärkeää: olemassa olevat Bearer-tunnukset pysyvät voimassa niiden voimassaolon päättymiseen asti $-merkki hyväksytään nyt AddressCode-kentässä |
| 1.25.3 | 10.2.2025 | ObjektissalinkedTasksonnytkolme uutta kenttää:subStatus,addressCode jareasons [taulukko]. – Näiden lisätietojen tarkoituksena on tarjota lisätietoa liittyvien tehtävien tilasta |
| 1.25.2 | 26.6.2025 | -tietueen juuritasolle on lisätty kenttäexternalCorrelationId – Tämän kentän voi täyttää vain tilauksen luonut osapuoli (InTask) – Kenttää ei voi päivittää – Kentän täyttäminen on vapaaehtoista – Pyynnön esittäjä voi täyttää kentän, jotta tehtävän voi yhdistää oman sisäisen järjestelmänsä tehtävään Gridsz |
| 1.25.1 | 3.4.2025 | Tehtiin muutoksia juuritasonlinkedTasks-kenttään. –taskType-kenttävalidoidaan nyt Enum-arvojen mukaisesti – Lisätty seuraavat kentät: mainStatus, planned, orgId Gridsz hyödyntää nyt myös linkedTasks-tehtäviä proaktiivisesti linkittämällä automaattisesti tehtäviä, jotka liittyvät toisiinsa, mutta eivät ole peräisin samasta tilauksesta tai tiketistä Esimerkiksi: jos INSTALL-tehtävä luodaan osoitteeseen, jolla on jo avoin FTU_CHANGE-tehtävä. Linkittämällä nämä tehtävät ja näyttämällä tärkeitä tietoja, kuten tilan, osapuolet saavat hyvän yleiskuvan |
| 1.25.0 | 20.3.2025 | Lisätty isPrivate -boolean-muuttuja Labels-luokkaan – Oletusarvoisesti label-objekti ei ole yksityinen |
| 1.24.0 | 3.6.2025 | Gridsz support nyt support tilauksia. – Tämä tarkoittaa, että on mahdollista vastaanottaa useita samaan liitäntään kuuluvia kuituja yhdessä tehtävässä Esimerkiksi sekä kuitu 1 että kuitu 2 voidaan vastaanottaa FTU_CONSTRUCT-tehtävässä Huomautus: PATCH-pohjaiset tehtävät koskevat aina yhtä kuitua kerrallaan, mikä tarkoittaa, että yhdessä tehtäväjoukossa voi olla kaksi PATCH_INSTALL-tehtävää – support olemme lisänneet API:hin seuraavat uudet objektit:PoPMultiInfo/HASMultiInfo/ConnectionMultiInfo Nämä kentät täytetään vain, jos verkon omistaja tai aktiiviset operaattorit pyytävät tilauksessaan monikuituyhteyttä toimittamalla useita kuituja Tämä tarkoittaa, että valtaosalle Gridsz ja -järjestelmistä näitä kenttiä ei koskaan täytetä! |