Her finner du informasjon om hvordan API kan benyttes for å legge inn prosjekter i Capitech fra et eksternt system som kilde for prosjekter.
CatalogueAPI - upsertProject
I dette API endepunktet kan en legge inn eller oppdatere prosjekter for angitt klient (firma)
Endepunktet er api/public/v1/Catalogue/upsertProject
Upsert prinsipp
Våre Upsert API endepunkter vil automatisk håndtere at evt. eksisterende record (prosjekt i dette tilfelle) oppdateres dersom det finnes fra før, hvis det ikke finnes vil det automatisk opprettes som ny record. Dette gjør det enklere og mer effektivt å realisere integrasjoner da eksternt system ikke trenger å sjekke / vite om recorden finnes fra før eller ikke.
Beskrivelse av Request parametere
Her er en beskrivelse og forklaring av hvilke parametre en kan benytte for å legge inn / oppdatere prosjekter. En kan få mer detaljer via mouseover på hhv. request parameter og retur felter i API oversikt.
Parameter | Påkrevd | Beskrivelse | Merknad |
|---|---|---|---|
| clientId | Ja | Klientnummer for hvilket firma en skal legge inn prosjekt på | |
| projectId | Ja | Prosjektnr | Som standard er dette prosjektnr (Integer) Dersom alfanumerisk støtte er aktivert |
på prosjekt dimensjon |
for aktuell klient er dette en streng. (varchar maks 20 tegn) Dersom alfanumerisk støtte er aktivert tildeles automatisk et løpenr som prosjektnummer. | |||
| description | Ja | Prosjektnavn | Maks 50 tegn |
| startDate | Nei | Startdato | Format yyyy-mm-dd |
| plannedFinishDate | Nei | Planlagt ferdigdato | Format yyyy-mm-dd |
| finishDate | Nei | Ferdigdato | Format yyyy-mm-dd |
| hourlyRate | Nei | Timesats | Decimal (size 7 scale 2) Kan evt. benyttes for rapportering / grovt estimat ressursbruk |
| status | Ja | Status | AK = Aktiv Prosjekt må være aktive for at de skal kunne benyttes i Capitech for timer, plan, fravær mv. Avlsuttede prosjekt er ikke valgbare for ansatte men historikk er tilgjengelig for rapportering mv. |
| usesSubProjects |
| Ja | Benytter underprosjekt | True / False. Default er False. Benyttes for å angi om underprosjekt skal kunne benyttes for dette prosjektet. | |
| projectCustomer | Nei | Oppdragsgiver | Maks 50 tegn |
| projectLeader | Nei | Prosjektleder | Maks 50 tegn |
| hmsRegnr | Nei | HMSReg id | Identifikator i HMSReg for evt. integrasjon til HmsReg Les om dette systemet her: www.hmsreg.no |
| acessToken | Ja | Token fra Login. | Kreves for å kjøre API request |
Returdata
Her er en beskrivelse og forklaring av returdata en får fra dette API og hva det i praksis kan benyttes til.
Felt | Beskrivelse | Eksempel | Merknad |
|---|---|---|---|
| displayErrormessage | Feilmelding for visning | An error occurred | Generell feilmelding |
| serverErrormessage | Server feilmelding | System.ArgumentException: Status value not accepted 'status' valid format is 'AK,PA,IP,AV'. Value received: \"U\ | Mer detaljert feilmelding med mer presis info om hva som feiler |
Skjermbilder
av prosjekt register i Capitech Flow med hhv. standard prosjektnummer og alfanumerisk støtte aktivert.
Når alfanumerisk støtte er aktivert tildeles automatisk et løpenr som prosjektnummer.
Eksempel på request
mot api/public/v1/Catalogue/upsertProject
{
"clientId": 100,
"projectId": 1500,
"description": "MittProsjekt",
"startDate": null,
"plannedFinishDate": null,
"finishDate": null,
"hourlyRate": null,
"status": "AK",
"usesSubProjects": "True",
"projectCustomer": null,
"projectLeader": null,
"hmsRegnr": null,
"accessToken": "gyldigaccesstokenher"
}
| Tip | ||
|---|---|---|
| ||
Du kan se mer detaljer om API parametere og returdata i en demoløsning her Demosalg.capitech.no/API |
| Tip |
|---|
Visste du at .... |