Servizi

prjsOpenAPI spec
API per la gestione dei progetti e delle anagrafiche collegate
project
Progetti e commesse
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di project.
workpackage
Attività di progetto (task della WBS)
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di workpackage.
milestone
Scadenze di progetto
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di milestone.
workActivity
Attività lavorative su progetto
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di workActivity.
workpackageMilestone
Milestones associate ai workpackage
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di workpackageMilestone...
revenue
Ricavi associati ai progetti
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di revenue.
cost
Costi associati ai progetti
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di cost.
revenueBudget
Ricavi previsti per i progetti
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di revenueBudget.
costBudget
Costi previsti per i progetti
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di costBudget.
projectArea
Aree di progetto
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di projectArea.
projectType
Tipologie di progetto
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di projectType.
projectStatus
Stati di progetto
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di projectStatus.
workpackageCategory
Categorie dei task di progetto (attività della WBS)
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di workpackageCategory...
projectTeam
Composizione dei team di progetto
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di projectTeam.
teamFunction
Ruoli funzionali di progetto
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di teamFunction.
workActivityArea
Tipologie di attività lavorative
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di workActivityArea...
revenueType
Tipologie di ricavo
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di revenueType.
costType
Tipologie di costo
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di costType.
revenueStatus
Stati dei ricavi
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di revenueStatus.
costStatus
Stati dei costi
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di costStatus.
systOpenAPI spec
API per la gestione delle anagrafiche di base
person
Anagrafica persone.
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di person.
user
Anagrafica utenti di sistema. Ogni utente è associato ad una persona.
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di user.
contact
Anagrafica contatti.
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di contact.
company
Anagrafica delle aziende (clienti / fornitori)
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di company.
jobContract
Contratti di lavoro
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di jobContract.
businessUnit
Anagrafica delle Business Unit
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di businessUnit.
subsidiary
Anagrafica delle sedi
Restituisce la risorsa corrispondente al codice identificativo specificato...
Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato...
Rimuove la risorsa corrispondente al codice identificativo specificato...

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati...

api.std_model_update_partial_multi_desc
Crea una nuova istanza di subsidiary.

Modelli

prjs
syst

prjs - API per la gestione dei progetti e delle anagrafiche collegate

In quest'area sono esposti i servizi utilizzabili per gestire:

  • i progetti
  • le WBS
  • le attività lavorative
  • le milestones
  • i costi
  • i ricavi
  • i budget
Sono inoltre definiti i servizi per gestire le anagrafiche "di contorno", come le tipologie e le aree di progetto, i ruoli funzionali di progetto, le tipologie dell attività lavorative, ecc.

Servizi prjs - project

Progetti e commesse

GET
/prjs/projects/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
project
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/projects/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
project - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
project
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/projects/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/projects

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
titlearray<LocalizedText>query
Titolo.
Dimensione massima: 50 chars
customerIdstringquery
Codice cliente.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa company.

companyIdstringquery
Codice azienda.
Dimensione massima: 30 chars
Il valore del campo non può essere modificato.

In fase di creazione é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa company.

projectTypeIdstringquery
Codice tipologia Progetto.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa projectType.

projectAreaIdstringquery
Codice area progetto.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa projectArea.

internalOrderRefstringquery
Riferimento ordine interno.
Dimensione massima: 255 chars
parentIdstringquery
Codice progetto padre.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa project.

startDatestringquery
Data Inizio.
formato: ISO 8601
endDatestringquery
Data chiusura.
formato: ISO 8601
estimatedEndDatestringquery
Data chiusura prevista.
formato: ISO 8601
internalintegerquery
a valore.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
openintegerquery
Aperto.
Dimensione massima: 2 digits
projectStatusIdintegerquery
Codice stato.
Dimensione massima: 11 digits
allowExtraTeamActintegerquery
Permetti attività extra team.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
stopActivitiesintegerquery
Blocca inserimento attività.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
priorityintegerquery
Priorità.
Dimensione massima: 11 digits
subsidiaryIdstringquery
Codice sede.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa subsidiary.

businessUnitIdstringquery
Codice business Unit / Dipartimenti.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa businessUnit.

_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<project>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/projects

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<project> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/project

Crea una nuova istanza di project.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
project - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
project
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - workpackage

Attività di progetto (task della WBS)

GET
/prjs/workpackages/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
workpackage
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/workpackages/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
workpackage - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
workpackage
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/workpackages/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/workpackages

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 50 chars
projectIdstringquery
Codice progetto.
Dimensione massima: 30 chars
Il valore del campo non può essere modificato.

In fase di creazione é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa project.

categoryIdstringquery
Codice classificazione attività.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workpackageCategory.

statusIdstringquery
Codice stato.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa projectStatus.

teamFunctionIdstringquery
Codice ruolo risorsa preposta.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa teamFunction.

dateFromstringquery
Data stimata inizio.
formato: ISO 8601
dateTostringquery
Data stimata fine.
formato: ISO 8601
notestringquery
Note.
Dimensione massima: 2048 chars
badgeTagstringquery
Etichetta.
Dimensione massima: 255 chars

Campo valorizzato in output. Non viene considerato dai servizi di creazione o aggiornamento, ma può essere usato come filtro nei servizi di interrogazione.

badgeTagStylestringquery
Label Style.
Dimensione massima: 255 chars

Campo valorizzato in output. Non viene considerato dai servizi di creazione o aggiornamento, ma può essere usato come filtro nei servizi di interrogazione.

_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<workpackage>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/workpackages

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<workpackage> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/workpackage

Crea una nuova istanza di workpackage.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
workpackage - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
workpackage
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - milestone

Scadenze di progetto

GET
/prjs/milestones/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
milestone
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/milestones/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
milestone - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
milestone
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/milestones/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/milestones

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
projectIdstringquery
Codice progetto.
Dimensione massima: 30 chars
Il valore del campo non può essere modificato.

In fase di creazione é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa project.

milestoneTypeintegerquery
Codice categoria Milestone.
Dimensione massima: 11 digits
datestringquery
Programmata il.
formato: ISO 8601
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<milestone>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/milestones

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<milestone> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/milestone

Crea una nuova istanza di milestone.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
milestone - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
milestone
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - workActivity

Attività lavorative su progetto

GET
/prjs/workActivities/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
workActivity
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/workActivities/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa.
Request Body (application/merge-patch+json)
workActivity - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
workActivity
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/workActivities/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/workActivities

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
projectIdstringquery
Codice progetto.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa project.

workpackageIdstringquery
Codice attività progetto (WBS).
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workpackage.

workActivityAreaIdstringquery
Codice attivita svolta.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workActivityArea.

userIdstringquery
Codice utente.
Dimensione massima: 30 chars

I possibili valori possono essere ricavati dalla risorsa user.

dateFromstringquery
Da.
formato: ISO 8601
dateTostringquery
a.
formato: ISO 8601
statestringquery
acronimo_stato.
Dimensione massima: 255 chars
Il valore del campo non può essere modificato..
Valori disponibili:
* BOZ(Bozza)
* CON(Approvata)
* ANN(Annullata)
* DEL(Cancellata)
* MOD(In modifica)
* EXE(Confermata)
* PLA(Pianificata)
* REJ(Rifiutata)

Campo valorizzato in output. Non viene considerato dai servizi di creazione o aggiornamento, ma può essere usato come filtro nei servizi di interrogazione.

outOfficeintegerquery
Posto svolgimento.
Dimensione massima: 11 digits.
Valori disponibili:
* 0(In ufficio)
* 1(Dal cliente)
* 2(Smart working)
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<workActivity>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/workActivities

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<workActivity> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/workActivity

Crea una nuova istanza di workActivity.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
workActivity - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
workActivity
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - workpackageMilestone

Milestones associate ai workpackage

GET
/prjs/workpackageMilestones/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
workpackageMilestone
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/workpackageMilestones/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa.
Request Body (application/merge-patch+json)
workpackageMilestone - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
workpackageMilestone
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/workpackageMilestones/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/workpackageMilestones

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
milestoneIdstringquery
Codice milestone.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa milestone.

workpackageIdstringquery
Codice attività progetto (WBS).
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workpackage.

typeintegerquery
prjs.tipo_di_milestone.
Dimensione massima: 11 digits.
Valori disponibili:
* 0(prjs.tipo_milestone_generica)
* 1(prjs.tipo_milestone_inizio_attivita)
* 2(prjs.tipo_milestone_fine_attivita)
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<workpackageMilestone>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/workpackageMilestones

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<workpackageMilestone> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/workpackageMilestone

Crea una nuova istanza di workpackageMilestone.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
workpackageMilestone - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
workpackageMilestone
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - revenue

Ricavi associati ai progetti

GET
/prjs/projects/{projectId}/revenues/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
revenue
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/projects/{projectId}/revenues/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
revenue - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
revenue
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/projects/{projectId}/revenues/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/projects/{projectId}/revenues

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
revenuenumberquery
Ricavo.
Valuta di riferimento: EUR
Dimensione massima: 18 digits
customerIdstringquery
Codice cliente.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa company.

projectModuleIdstringquery
Codice attività della WBS.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workpackage.

typeIdstringquery
Codice classificazione costo/ricavo.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa revenueType.

revenueCategoryIdstringquery
Codice prjs.categoria.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

statusIdstringquery
Codice stato.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa revenueStatus.

_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<revenue>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/projects/{projectId}/revenues

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
array<revenue> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/projects/{projectId}/revenue

Crea una nuova istanza di revenue.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/json)
revenue - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
revenue
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - cost

Costi associati ai progetti

GET
/prjs/projects/{projectId}/costs/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
cost
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/projects/{projectId}/costs/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
cost - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
cost
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/projects/{projectId}/costs/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/projects/{projectId}/costs

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
costnumberquery
Costo.
Valuta di riferimento: EUR
Dimensione massima: 18 digits
directintegerquery
prjs.costo_diretto.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
supplierIdstringquery
Codice fornitore.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa company.

projectModuleIdstringquery
Codice attività della WBS.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workpackage.

typeIdstringquery
Codice classificazione costo/ricavo.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa costType.

revenueCategoryIdstringquery
Codice prjs.categoria.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

statusIdstringquery
Codice stato.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa costStatus.

_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<cost>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/projects/{projectId}/costs

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
array<cost> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/projects/{projectId}/cost

Crea una nuova istanza di cost.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/json)
cost - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
cost
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - revenueBudget

Ricavi previsti per i progetti

GET
/prjs/projects/{projectId}/revenueBudgets/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
revenueBudget
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/projects/{projectId}/revenueBudgets/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
revenueBudget - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
revenueBudget
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/projects/{projectId}/revenueBudgets/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/projects/{projectId}/revenueBudgets

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
pertinenceMonthintegerquery
mese_pertinenza.
Dimensione massima: 2 digits
pertinenceYearintegerquery
Anno di pertinenza.
Dimensione massima: 4 digits
revenuenumberquery
Ricavo.
Valuta di riferimento: EUR
Dimensione massima: 18 digits
customerIdstringquery
Codice cliente.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa company.

projectModuleIdstringquery
Codice attività della WBS.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workpackage.

typeIdstringquery
Codice classificazione costo/ricavo.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa revenueType.

revenueCategoryIdstringquery
Codice prjs.categoria.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<revenueBudget>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/projects/{projectId}/revenueBudgets

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
array<revenueBudget> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/projects/{projectId}/revenueBudget

Crea una nuova istanza di revenueBudget.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/json)
revenueBudget - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
revenueBudget
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - costBudget

Costi previsti per i progetti

GET
/prjs/projects/{projectId}/costBudgets/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
costBudget
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/projects/{projectId}/costBudgets/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
costBudget - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
costBudget
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/projects/{projectId}/costBudgets/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/projects/{projectId}/costBudgets

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
pertinenceMonthintegerquery
mese_pertinenza.
Dimensione massima: 2 digits
pertinenceYearintegerquery
Anno di pertinenza.
Dimensione massima: 4 digits
costnumberquery
Costo.
Valuta di riferimento: EUR
Dimensione massima: 18 digits
directintegerquery
prjs.costo_diretto.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
supplierIdstringquery
Codice fornitore.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa company.

projectModuleIdstringquery
Codice attività della WBS.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workpackage.

typeIdstringquery
Codice classificazione costo/ricavo.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa costType.

revenueCategoryIdstringquery
Codice prjs.categoria.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<costBudget>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/projects/{projectId}/costBudgets

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
array<costBudget> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/projects/{projectId}/costBudget

Crea una nuova istanza di costBudget.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
projectIdstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/json)
costBudget - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
costBudget
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - projectArea

Aree di progetto

GET
/prjs/projectAreas/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
projectArea
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/projectAreas/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
projectArea - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
projectArea
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/projectAreas/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/projectAreas

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 10 chars
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<projectArea>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/projectAreas

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<projectArea> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/projectArea

Crea una nuova istanza di projectArea.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
projectArea - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
projectArea
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - projectType

Tipologie di progetto

GET
/prjs/projectTypes/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
projectType
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/projectTypes/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
projectType - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
projectType
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/projectTypes/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/projectTypes

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<projectType>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/projectTypes

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<projectType> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/projectType

Crea una nuova istanza di projectType.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
projectType - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
projectType
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - projectStatus

Stati di progetto

GET
/prjs/projectStatuses/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
projectStatus
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/projectStatuses/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
projectStatus - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
projectStatus
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/projectStatuses/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/projectStatuses

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 50 chars
typeStatusintegerquery
Tipo stato.
Dimensione massima: 11 digits
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<projectStatus>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/projectStatuses

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<projectStatus> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/projectStatus

Crea una nuova istanza di projectStatus.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
projectStatus - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
projectStatus
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - workpackageCategory

Categorie dei task di progetto (attività della WBS)

GET
/prjs/workpackageCategories/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
workpackageCategory
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/workpackageCategories/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
workpackageCategory - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
workpackageCategory
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/workpackageCategories/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/workpackageCategories

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<workpackageCategory>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/workpackageCategories

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<workpackageCategory> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/workpackageCategory

Crea una nuova istanza di workpackageCategory.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
workpackageCategory - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
workpackageCategory
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - projectTeam

Composizione dei team di progetto

GET
/prjs/projectTeams/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
projectTeam
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/projectTeams/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa.
Request Body (application/merge-patch+json)
projectTeam - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
projectTeam
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/projectTeams/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/projectTeams

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
projectIdstringquery
Codice progetto.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa project.

projectTeamFunctionIdstringquery
Codice funzione.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa teamFunction.

userIdstringquery
Codice persona.
Dimensione massima: 30 chars

I possibili valori possono essere ricavati dalla risorsa user.

workHHPerDaysnumberquery
Unita lavorativa.
Dimensione massima: 3 digits
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<projectTeam>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/projectTeams

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<projectTeam> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/projectTeam

Crea una nuova istanza di projectTeam.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
projectTeam - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
projectTeam
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - teamFunction

Ruoli funzionali di progetto

GET
/prjs/teamFunctions/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
teamFunction
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/teamFunctions/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
teamFunction - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
teamFunction
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/teamFunctions/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/teamFunctions

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<teamFunction>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/teamFunctions

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<teamFunction> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/teamFunction

Crea una nuova istanza di teamFunction.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
teamFunction - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
teamFunction
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - workActivityArea

Tipologie di attività lavorative

GET
/prjs/workActivityAreas/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
workActivityArea
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/workActivityAreas/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
workActivityArea - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
workActivityArea
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/workActivityAreas/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/workActivityAreas

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 7 chars
visibilityintegerquery
Visibilità.
Dimensione massima: 11 digits
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<workActivityArea>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/workActivityAreas

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<workActivityArea> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/workActivityArea

Crea una nuova istanza di workActivityArea.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
workActivityArea - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
workActivityArea
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - revenueType

Tipologie di ricavo

GET
/prjs/revenueTypes/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
revenueType
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/revenueTypes/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
revenueType - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
revenueType
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/revenueTypes/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/revenueTypes

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
revenueintegerquery
Competenza classificazione.
Dimensione massima: 1 digits
directintegerquery
prjs.costo_diretto.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
revenueCategoryIdintegerquery
Codice prjs.categoria.
Dimensione massima: 0
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<revenueType>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/revenueTypes

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<revenueType> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/revenueType

Crea una nuova istanza di revenueType.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
revenueType - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
revenueType
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - costType

Tipologie di costo

GET
/prjs/costTypes/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
costType
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/costTypes/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
costType - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
costType
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/costTypes/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/costTypes

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
revenueintegerquery
Competenza classificazione.
Dimensione massima: 1 digits
directintegerquery
prjs.costo_diretto.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
revenueCategoryIdintegerquery
Codice prjs.categoria.
Dimensione massima: 0
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<costType>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/costTypes

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<costType> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/costType

Crea una nuova istanza di costType.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
costType - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
costType
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - revenueStatus

Stati dei ricavi

GET
/prjs/revenueStatuses/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
revenueStatus
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/revenueStatuses/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
revenueStatus - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
revenueStatus
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/revenueStatuses/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/revenueStatuses

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<revenueStatus>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/revenueStatuses

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<revenueStatus> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/revenueStatus

Crea una nuova istanza di revenueStatus.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
revenueStatus - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
revenueStatus
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi prjs - costStatus

Stati dei costi

GET
/prjs/costStatuses/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
costStatus
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/prjs/costStatuses/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
costStatus - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
costStatus
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/prjs/costStatuses/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/prjs/costStatuses

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<costStatus>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/prjs/costStatuses

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<costStatus> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/prjs/costStatus

Crea una nuova istanza di costStatus.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
costStatus - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
costStatus
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore

syst - API per la gestione delle anagrafiche di base

Common services

Servizi syst - person

Anagrafica persone.

GET
/syst/persons/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
person
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/syst/persons/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
person - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
person
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/syst/persons/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/syst/persons

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
namestringquery
Nome.
Dimensione massima: 255 chars
surnamestringquery
Cognome.
Dimensione massima: 255 chars
subsidiaryIdintegerquery
Codice sede assegnata.
Dimensione massima: 11 digits
businessUnitIdintegerquery
Codice divisione.
Dimensione massima: 11 digits
pivastringquery
Partita IVA.
Dimensione massima: 255 chars
pivacfstringquery
Codice fiscale.
Dimensione massima: 255 chars
emailstringquery
E-mail.
Dimensione massima: 255 chars
pecstringquery
Pec.
Dimensione massima: 255 chars
languageIdintegerquery
Codice lingua.
Dimensione massima: 255 digits
provinceIdintegerquery
Codice provincia.
Dimensione massima: 11 digits
regionIdintegerquery
Codice regione.
Dimensione massima: 11 digits
countryIdintegerquery
Codice paese.
Dimensione massima: 11 digits
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<person>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/syst/persons

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<person> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/syst/person

Crea una nuova istanza di person.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
person - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
person
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi syst - user

Anagrafica utenti di sistema. Ogni utente è associato ad una persona.

GET
/syst/users/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
user
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/syst/users/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa.
Request Body (application/merge-patch+json)
user - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
user
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/syst/users/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/syst/users

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
loginstringquery
Login.
Dimensione massima: 75 chars
passwordstringquery
Password.
Dimensione massima: 50 chars
userTypeIdintegerquery
Codice tipo utente.
Dimensione massima: 11 digits
internalintegerquery
Interno.
Dimensione massima: 11 digits
activeintegerquery
Attivo.
Dimensione massima: 11 digits
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<user>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/syst/users

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<user> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/syst/user

Crea una nuova istanza di user.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
user - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
user
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi syst - contact

Anagrafica contatti.

GET
/syst/contacts/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
contact
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/syst/contacts/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
contact - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
contact
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/syst/contacts/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/syst/contacts

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
codestringquery
Transcodifica contatto.
Dimensione massima: 30 chars
sharedintegerquery
Contatto condiviso.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
namestringquery
Nome.
Dimensione massima: 50 chars
surnamestringquery
Cognome.
Dimensione massima: 50 chars
emailstringquery
E-mail.
Dimensione massima: 75 chars
emailCompanystringquery
Email aziendale.
Dimensione massima: 75 chars
idCountryintegerquery
Paese.
Dimensione massima: 11 digits
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<contact>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/syst/contacts

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<contact> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/syst/contact

Crea una nuova istanza di contact.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
contact - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
contact
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi syst - company

Anagrafica delle aziende (clienti / fornitori)

GET
/syst/companies/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
company
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/syst/companies/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
company - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
company
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/syst/companies/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/syst/companies

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringquery
Codice identificativo univoco di transcodifica.
Dimensione massima: 15 chars
namestringquery
Nome azienda.
Dimensione massima: 255 chars
designationintegerquery
Codice forma giuridica.
Dimensione massima: 11 digits.
Valori disponibili:
* 1(Società per azioni (S.p.a.))
* 15(Società per azioni con socio unico (S.p.a.))
* 4(Società in accomandita per azioni (S.a.p.a.))
* 2(Società a responsabilità limitata (S.r.l.))
* 3(Società a responsabilità limitata unipersonale (S.r.l.u.))
* 14(Società a responsabilità limitata semplificata (S.r.l.s.))
* 5(Società Semplice (S.s.))
* 6(Società in nome collettivo (S.n.c.))
* 7(Società in accomandita semplice (S.a.s.))
* 8(Soc. Coop. a responsabilità illimitata (S.c.))
* 9(Soc. Coop. a responsabilità limitata (S.c.r.l.))
* 16(Società cooperativa agricola (s.c.a.))
* 10(Impresa Familiare)
* 11(Impresa Coniugale)
* 19(Pubblica Amministrazione)
* 12(Onlus)
* 17(Società consortile a resp. limitata)
* 18(Società consortile per azioni)
* 20(Fondazione)
countrystringquery
Codice paese.
Dimensione massima: 11 chars
pecstringquery
Pec.
Dimensione massima: 255 chars
pistringquery
Partita IVA.
Dimensione massima: 255 chars
codeInvoiceITstringquery
Codice destinatario fatturazione elettronica (solo Italia).
Dimensione massima: 7 chars
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<company>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/syst/companies

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<company> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/syst/company

Crea una nuova istanza di company.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
company - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
company
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi syst - jobContract

Contratti di lavoro

GET
/syst/jobContracts/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
jobContract
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/syst/jobContracts/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa.
Request Body (application/merge-patch+json)
jobContract - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
jobContract
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/syst/jobContracts/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/syst/jobContracts

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
userIdstringquery
Codice persona.
Dimensione massima: 30 chars
Il valore del campo non può essere modificato.

I possibili valori possono essere ricavati dalla risorsa user.

typeIdintegerquery
Codice tipo.
Dimensione massima: 11 digits.
Valori disponibili:
* 1(contratto_tempo_indeterminato)
* 2(contratto_tempo_determinato)
* 3(contratto_mandato_amministratore)
* 4(contratto_inserimento)
* 5(contratto_apprendistato)
* 6(contratto_tempo_parziale)
* 7(contratto_somministrazione_lavoro)
* 8(contratto_lavoro_ripartito)
* 9(contratto_a_chiamata)
* 10(contratto_a_progetto)
* 11(contratto_a_progetto)
* 12(contratto_lavoro_occasionale)
* 13(contratto_lavoro_accessorio)
* 14(tirocinio)
* 15(contratto_mandato_agenzia)
contractCodestringquery
Codice contratto.
Dimensione massima: 40 chars
dateFromstringquery
Valido da.
formato: ISO 8601
dateTostringquery
Valido a.
formato: ISO 8601
workHHPerDaysnumberquery
Unita lavorativa.
Dimensione massima: 3 digits
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<jobContract>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/syst/jobContracts

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<jobContract> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/syst/jobContract

Crea una nuova istanza di jobContract.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
jobContract - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
jobContract
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi syst - businessUnit

Anagrafica delle Business Unit

GET
/syst/businessUnits/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
businessUnit
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/syst/businessUnits/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
businessUnit - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
businessUnit
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/syst/businessUnits/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/syst/businessUnits

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<businessUnit>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/syst/businessUnits

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<businessUnit> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/syst/businessUnit

Crea una nuova istanza di businessUnit.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
businessUnit - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
businessUnit
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Servizi syst - subsidiary

Anagrafica delle sedi

GET
/syst/subsidiaries/{id}

Restituisce la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
subsidiary
La risorsa con i campi valorizzati.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

PATCH
/syst/subsidiaries/{id}

Modifica i valori dei soli campi valorizzati nel parametro in input per la risorsa identificata dal codice specificato. Gli altri campi della risorsa rimarranno immutati.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Request Body (application/merge-patch+json)
subsidiary - La risorsa da aggiornare. Nessuno dei campi è obbligatorio, solamente quelli valorizzati saranno modificati.
Risposte
HTTP codeschemadesc
200
subsidiary
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

DELETE
/syst/subsidiaries/{id}

Rimuove la risorsa corrispondente al codice identificativo specificato.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
idstringpath
Codice identificativo della risorsa. In input è possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.
Risposte
HTTP codeschemadesc
204
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

GET
/syst/subsidiaries

Restituisce una lista di risorse corrispondenti ai parametri di ricerca specificati.

Per ogni parametro è possibile indicare l'operatore di confronto da utilizzare, tra i seguenti:

  • lt: verranno estratti solamente i valori minori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • lte: verranno estratti solamente i valori minori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gt: verranno estratti solamente i valori maggiori di quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • gte: verranno estratti solamente i valori maggiori o uguali a quello specificato. Questo operatore è utilizzabile solo per i tipi di dato numerici o data.
  • eq: verranno estratti solamente i valori uguali a quello specificato (operatore di default)
  • neq: verranno estratti solamente i valori diversi a quello specificato
  • cnt: verranno estratti solamente i valori contenenti quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ncnt: verranno estratti solamente i valori che npn contenengono quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • sw: verranno estratti solamente i valori che iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • nsw: verranno estratti solamente i valori che NON iniziano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • ew: verranno estratti solamente i valori che terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.
  • new: verranno estratti solamente i valori che NON terminano con quello specificato. Questo operatore è utilizzabile solamente per i tipi di dato testuali.

Per indicare un operatore per un determinato campo, è necessario includerlo tra parentesi quadre. Ad esempio:

?price[lt]=100

Se specficati più criteri di ricerca, verranno estratte le risorse che soddisfano tutte le condizioni, ad esempio:

?price[gt]=50&price[lt]=100&name[cnt]=cuffie

Se non viene specificato alcun operatore, verrà applicato di default l'operatore di uguaglianza (eq).

La risposta del server riporta le seguenti informazioni codificate all'interno di header HTTP:

  • link rilevanti alle evenutali altre "pagine" di risultati nell'header "Link", secondo le specifiche RFC8288 (Web Linking),sezione 3.
  • numero totale di risorse, nell'header "X-Total-Count".
Parametri
nametypeindesc
idintegerquery
Codice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
_pageintegerquery
Numero della "pagina" da estrarre. Se non specificato verrà restituita la prima pagina.
_limitintegerquery
Numero di elementi da restituire. [default: 20, max: 100]
_fieldsstringquery
Lista separata da virgole dei campi della risorsa da restituire. Se non specificato verranno restituiti tutti i campi della risorsa.
Risposte
HTTP codeschemadesc
200
array<subsidiary>
La lista delle risorse corrispondenti ai criteri di ricerca.
400
string
Il motivo dell'errore

PATCH
/syst/subsidiaries

api.std_model_update_partial_multi_desc
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/merge-patch+json)
array<subsidiary> - api.std_model_method_upd_partial_multi_param_desc
Risposte
HTTP codeschemadesc
200
Se la richiesta è andata a buon fine.
404
Nel caso in cui il codice richiesto non esista.
400
string
Il motivo dell'errore

POST
/syst/subsidiary

Crea una nuova istanza di subsidiary.
Parametri
nametypeindesc
Use-Transcoded-Codesintegerheader
Se valorizzato a "0", TUTTI i parametri e i campi utilizzati per l'invocazione del servizio che si riferiscono ai codici identificativi di risorse saranno trattati come identificativi interni. Se valorizzato a "1", saranno trattati come codici "esterni" di transcodifica. [default: 0]
esempio: Use-Transcoded-Codes: 1
Request Body (application/json)
subsidiary - La risorsa con i campi valorizzati.
Risposte
HTTP codeschemadesc
201
subsidiary
Se la richiesta è andata a buon fine.
400
string
Il motivo dell'errore
Modelli prjs - cost
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
projectIdstringCodice progetto.
Dimensione massima: 30 chars
Il valore del campo non può essere modificato.

In fase di creazione é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa project.

registrationDatestringdata_pertinenza.
formato: ISO 8601
costnumberCosto.
Valuta di riferimento: EUR
Dimensione massima: 18 digits
directintegerprjs.costo_diretto.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
descriptionstringDescrizione.
Dimensione massima: 105 chars
supplierIdstringCodice fornitore.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa company.

projectModuleIdstringCodice attività della WBS.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workpackage.

typeIdstringCodice classificazione costo/ricavo.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa costType.

revenueCategoryIdstringCodice prjs.categoria.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

statusIdstringCodice stato.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa costStatus.

operationDatestringData operazione.
formato: ISO 8601
paymentDatestringData pagamento.
formato: ISO 8601
notesstringNote.
Dimensione massima: -1
Modelli prjs - costBudget
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
projectIdstringCodice progetto.
Dimensione massima: 30 chars
Il valore del campo non può essere modificato.

In fase di creazione é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa project.

pertinenceMonthintegermese_pertinenza.
Dimensione massima: 2 digits
pertinenceYearintegerAnno di pertinenza.
Dimensione massima: 4 digits
costnumberCosto.
Valuta di riferimento: EUR
Dimensione massima: 18 digits
directintegerprjs.costo_diretto.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
descriptionstringDescrizione.
Dimensione massima: 105 chars
supplierIdstringCodice fornitore.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa company.

projectModuleIdstringCodice attività della WBS.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workpackage.

typeIdstringCodice classificazione costo/ricavo.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa costType.

revenueCategoryIdstringCodice prjs.categoria.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

notesstringNote.
Dimensione massima: -1
Modelli prjs - costStatus
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
namearray<LocalizedText>Nome.
Dimensione massima: 50 chars
descriptionarray<LocalizedText>Descrizione.
Dimensione massima: 2048 chars
Modelli prjs - costType
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
namearray<LocalizedText>Nome.
Dimensione massima: 105 chars
revenueintegerCompetenza classificazione.
Dimensione massima: 1 digits
descriptionarray<LocalizedText>Descrizione.
Dimensione massima: 2048 chars
directintegerprjs.costo_diretto.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
revenueCategoryIdintegerCodice prjs.categoria.
Dimensione massima: 0
Modelli prjs - milestone
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
projectIdstringCodice progetto.
Dimensione massima: 30 chars
Il valore del campo non può essere modificato.

In fase di creazione é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa project.

namestringMilestone.
Dimensione massima: 255 chars
milestoneTypeintegerCodice categoria Milestone.
Dimensione massima: 11 digits
datestringProgrammata il.
formato: ISO 8601
effectiveDatestringEseguita il.
formato: ISO 8601
descriptionstringDescrizione.
Dimensione massima: 4096 chars
Modelli prjs - project
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
titlearray<LocalizedText>Titolo.
Dimensione massima: 50 chars
descriptionarray<LocalizedText>Descrizione.
Dimensione massima: 4096 chars
customerIdstringCodice cliente.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa company.

companyIdstringCodice azienda.
Dimensione massima: 30 chars
Il valore del campo non può essere modificato.

In fase di creazione é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa company.

projectTypeIdstringCodice tipologia Progetto.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa projectType.

projectAreaIdstringCodice area progetto.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa projectArea.

internalOrderRefstringRiferimento ordine interno.
Dimensione massima: 255 chars
orderReferencestringRiferimento ordine cliente.
Dimensione massima: 255 chars
parentIdstringCodice progetto padre.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa project.

startDatestringData Inizio.
formato: ISO 8601
endDatestringData chiusura.
formato: ISO 8601
estimatedEndDatestringData chiusura prevista.
formato: ISO 8601
internalintegera valore.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
openintegerAperto.
Dimensione massima: 2 digits
projectStatusIdintegerCodice stato.
Dimensione massima: 11 digits
allowExtraTeamActintegerPermetti attività extra team.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
stopActivitiesintegerBlocca inserimento attività.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
priorityintegerPriorità.
Dimensione massima: 11 digits
subsidiaryIdstringCodice sede.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa subsidiary.

businessUnitIdstringCodice business Unit / Dipartimenti.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa businessUnit.

notesstringNote.
Dimensione massima: -1
projectUrlstringprojectCardPagePath.
Modelli prjs - projectArea
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 10 chars
namearray<LocalizedText>Nome.
Dimensione massima: 50 chars
Modelli prjs - projectStatus
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 50 chars
namearray<LocalizedText>Nome.
Dimensione massima: 50 chars
typeStatusintegerTipo stato.
Dimensione massima: 11 digits
descriptionarray<LocalizedText>Descrizione.
Dimensione massima: -1
Modelli prjs - projectTeam
propertytypedesc
projectIdstringCodice progetto.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa project.

projectTeamFunctionIdstringCodice funzione.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa teamFunction.

userIdstringCodice persona.
Dimensione massima: 30 chars

I possibili valori possono essere ricavati dalla risorsa user.

dateFromstringDa.
formato: ISO 8601
dateTostringa.
formato: ISO 8601
workHHPerDaysnumberUnita lavorativa.
Dimensione massima: 3 digits
Modelli prjs - projectType
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
namearray<LocalizedText>Nome.
Dimensione massima: 50 chars
descriptionarray<LocalizedText>Descrizione.
Dimensione massima: 2048 chars
Modelli prjs - revenue
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
projectIdstringCodice progetto.
Dimensione massima: 30 chars
Il valore del campo non può essere modificato.

In fase di creazione é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa project.

registrationDatestringdata_pertinenza.
formato: ISO 8601
revenuenumberRicavo.
Valuta di riferimento: EUR
Dimensione massima: 18 digits
descriptionstringDescrizione.
Dimensione massima: 105 chars
customerIdstringCodice cliente.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa company.

projectModuleIdstringCodice attività della WBS.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workpackage.

typeIdstringCodice classificazione costo/ricavo.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa revenueType.

revenueCategoryIdstringCodice prjs.categoria.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

statusIdstringCodice stato.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa revenueStatus.

operationDatestringData operazione.
formato: ISO 8601
paymentDatestringData pagamento.
formato: ISO 8601
notesstringNote.
Dimensione massima: -1
Modelli prjs - revenueBudget
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
projectIdstringCodice progetto.
Dimensione massima: 30 chars
Il valore del campo non può essere modificato.

In fase di creazione é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa project.

pertinenceMonthintegermese_pertinenza.
Dimensione massima: 2 digits
pertinenceYearintegerAnno di pertinenza.
Dimensione massima: 4 digits
revenuenumberRicavo.
Valuta di riferimento: EUR
Dimensione massima: 18 digits
descriptionstringDescrizione.
Dimensione massima: 105 chars
customerIdstringCodice cliente.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa company.

projectModuleIdstringCodice attività della WBS.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workpackage.

typeIdstringCodice classificazione costo/ricavo.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa revenueType.

revenueCategoryIdstringCodice prjs.categoria.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

notesstringNote.
Dimensione massima: -1
Modelli prjs - revenueStatus
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
namearray<LocalizedText>Nome.
Dimensione massima: 50 chars
descriptionarray<LocalizedText>Descrizione.
Dimensione massima: 2048 chars
Modelli prjs - revenueType
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
namearray<LocalizedText>Nome.
Dimensione massima: 105 chars
revenueintegerCompetenza classificazione.
Dimensione massima: 1 digits
descriptionarray<LocalizedText>Descrizione.
Dimensione massima: 2048 chars
directintegerprjs.costo_diretto.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
revenueCategoryIdintegerCodice prjs.categoria.
Dimensione massima: 0
Modelli prjs - teamFunction
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
namearray<LocalizedText>Nome.
Dimensione massima: 50 chars
isProjectManagerintegerAmministratore progetto.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
colorstringColore.
Dimensione massima: 7 chars
positionintegerPosizione.
Dimensione massima: 9 digits
descriptionarray<LocalizedText>Descrizione.
Dimensione massima: 2048 chars
Modelli prjs - workActivity
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
projectIdstringCodice progetto.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa project.

workpackageIdstringCodice attività progetto (WBS).
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workpackage.

workActivityAreaIdstringCodice attivita svolta.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workActivityArea.

userIdstringCodice utente.
Dimensione massima: 30 chars

I possibili valori possono essere ricavati dalla risorsa user.

dateFromstringDa.
formato: ISO 8601
dateTostringa.
formato: ISO 8601
statestringacronimo_stato.
Dimensione massima: 255 chars
Il valore del campo non può essere modificato..
Valori disponibili:
* BOZ(Bozza)
* CON(Approvata)
* ANN(Annullata)
* DEL(Cancellata)
* MOD(In modifica)
* EXE(Confermata)
* PLA(Pianificata)
* REJ(Rifiutata)

Campo valorizzato in output. Non viene considerato dai servizi di creazione o aggiornamento, ma può essere usato come filtro nei servizi di interrogazione.

descriptionstringDescrizione.
Dimensione massima: 2048 chars
lunchBreakintegerPausa pranzo.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
outOfficeintegerPosto svolgimento.
Dimensione massima: 11 digits.
Valori disponibili:
* 0(In ufficio)
* 1(Dal cliente)
* 2(Smart working)
Modelli prjs - workActivityArea
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 7 chars
namearray<LocalizedText>Nome.
Dimensione massima: 50 chars
subTitlearray<LocalizedText>Sottotitolo.
Dimensione massima: 50 chars
colorstringColore.
Dimensione massima: 7 chars
positionintegerPosizione.
Dimensione massima: 9 digits
visibilityintegerVisibilità.
Dimensione massima: 11 digits
descriptionarray<LocalizedText>Descrizione.
Dimensione massima: 4096 chars
Modelli prjs - workpackage
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 50 chars
namearray<LocalizedText>Nome.
Dimensione massima: 60 chars
projectIdstringCodice progetto.
Dimensione massima: 30 chars
Il valore del campo non può essere modificato.

In fase di creazione é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa project.

categoryIdstringCodice classificazione attività.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workpackageCategory.

statusIdstringCodice stato.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa projectStatus.

teamFunctionIdstringCodice ruolo risorsa preposta.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa teamFunction.

orderReferencestringRiferimento ordine cliente.
Dimensione massima: 255 chars
dateFromstringData stimata inizio.
formato: ISO 8601
dateTostringData stimata fine.
formato: ISO 8601
estimatedDaysnumberStima giorni.
Dimensione massima: 16 digits
stopActivitiesintegerBlocca inserimento attività.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
overrunAcceptednumberSforamento accettato.
Dimensione massima: 11 digits
overrunTypeintegerTipologia sforamento.
Dimensione massima: 11 digits.
Valori disponibili:
* 0(Percentuale)
* 1(Giorni)
stopActivitiesOnOverrunintegerBlocca attività dopo sforamento.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
descriptionarray<LocalizedText>Descrizione.
Dimensione massima: -1
notestringNote.
Dimensione massima: 2048 chars
badgeTagstringEtichetta.
Dimensione massima: 255 chars

Campo valorizzato in output. Non viene considerato dai servizi di creazione o aggiornamento, ma può essere usato come filtro nei servizi di interrogazione.

badgeTagStylestringLabel Style.
Dimensione massima: 255 chars

Campo valorizzato in output. Non viene considerato dai servizi di creazione o aggiornamento, ma può essere usato come filtro nei servizi di interrogazione.

percStatusnumberStato avanzamento.
Dimensione massima: 5 digits

Campo valorizzato solo in output. Non viene considerato dai servizi di creazione o aggiornamento.

Modelli prjs - workpackageCategory
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
namearray<LocalizedText>Nome.
Dimensione massima: 75 chars
descriptionarray<LocalizedText>Descrizione.
Dimensione massima: 5120 chars
Modelli prjs - workpackageMilestone
propertytypedesc
milestoneIdstringCodice milestone.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa milestone.

workpackageIdstringCodice attività progetto (WBS).
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa workpackage.

typeintegerprjs.tipo_di_milestone.
Dimensione massima: 11 digits.
Valori disponibili:
* 0(prjs.tipo_milestone_generica)
* 1(prjs.tipo_milestone_inizio_attivita)
* 2(prjs.tipo_milestone_fine_attivita)
Modelli syst - businessUnit
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
namestringNome.
Dimensione massima: 255 chars
descriptionarray<LocalizedText>Descrizione.
Dimensione massima: 1024 chars
addressstringIndirizzo.
Dimensione massima: 150 chars
streetNumberstringCivico.
Dimensione massima: 5 chars
zipcodestringCAP.
Dimensione massima: 25 chars
citystringCitta.
Dimensione massima: 50 chars
countystringProvincia.
Dimensione massima: 25 chars
telephonestringTelefono.
Dimensione massima: 35 chars
faxstringFax.
Dimensione massima: 35 chars
websitestringSito web.
Dimensione massima: 75 chars
emailstringE-mail.
Dimensione massima: 75 chars
Modelli syst - company
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 15 chars
namestringNome azienda.
Dimensione massima: 255 chars
businessNamestringDenominazione commerciale.
Dimensione massima: 255 chars
designationintegerCodice forma giuridica.
Dimensione massima: 11 digits.
Valori disponibili:
* 1(Società per azioni (S.p.a.))
* 15(Società per azioni con socio unico (S.p.a.))
* 4(Società in accomandita per azioni (S.a.p.a.))
* 2(Società a responsabilità limitata (S.r.l.))
* 3(Società a responsabilità limitata unipersonale (S.r.l.u.))
* 14(Società a responsabilità limitata semplificata (S.r.l.s.))
* 5(Società Semplice (S.s.))
* 6(Società in nome collettivo (S.n.c.))
* 7(Società in accomandita semplice (S.a.s.))
* 8(Soc. Coop. a responsabilità illimitata (S.c.))
* 9(Soc. Coop. a responsabilità limitata (S.c.r.l.))
* 16(Società cooperativa agricola (s.c.a.))
* 10(Impresa Familiare)
* 11(Impresa Coniugale)
* 19(Pubblica Amministrazione)
* 12(Onlus)
* 17(Società consortile a resp. limitata)
* 18(Società consortile per azioni)
* 20(Fondazione)
addressstringIndirizzo.
Dimensione massima: 75 chars
streetNumberstringCivico.
Dimensione massima: 7 chars
zipcodestringCAP.
Dimensione massima: 10 chars
citystringCitta.
Dimensione massima: 255 chars
countystringProvincia.
Dimensione massima: 8 chars
countrystringCodice paese.
Dimensione massima: 11 chars
registeredAddressstringSede legale.
Dimensione massima: 300 chars
invoiceAddressstringIndirizzo di fatturazione.
Dimensione massima: 300 chars
phonestringTelefono.
Dimensione massima: 255 chars
faxstringFax.
Dimensione massima: 255 chars
freePhoneNumberstringNumero verde.
Dimensione massima: 255 chars
companyemailstringEmail di contatto.
Dimensione massima: 255 chars
invoiceEmailstringEmail di fatturazione.
Dimensione massima: 255 chars
pecstringPec.
Dimensione massima: 255 chars
companywebsitestringSito web.
Dimensione massima: 255 chars
pistringPartita IVA.
Dimensione massima: 255 chars
piCountryCodestringCodice ISO.
Dimensione massima: 2 chars
codeInvoiceITstringCodice destinatario fatturazione elettronica (solo Italia).
Dimensione massima: 7 chars
fiscalcodestringCodice fiscale.
Dimensione massima: 255 chars
reastringRea N°.
Dimensione massima: 18 chars
reaOfficestringUfficio REA.
Dimensione massima: 30 chars
capitalStockintegerCapitale sociale.
Dimensione massima: 20 digits
lastRevenueintegerUltimo Fatturato.
Dimensione massima: 20 digits
yearRevenueintegerAnno ultimo fatturato.
Dimensione massima: 4 digits
Modelli syst - contact
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
codestringTranscodifica contatto.
Dimensione massima: 30 chars
sharedintegerContatto condiviso.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
namestringNome.
Dimensione massima: 50 chars
surnamestringCognome.
Dimensione massima: 50 chars
nicknamestringNickname.
Dimensione massima: 40 chars
sexstringSesso.
Dimensione massima: 255 chars
emailstringE-mail.
Dimensione massima: 75 chars
emailCompanystringEmail aziendale.
Dimensione massima: 75 chars
skypestringSkype.
Dimensione massima: 30 chars
addressstringIndirizzo.
Dimensione massima: 255 chars
streetNumberstringCivico.
Dimensione massima: 10 chars
postCodestringCAP.
Dimensione massima: 10 chars
citystringCitta.
Dimensione massima: 255 chars
countystringProvincia.
Dimensione massima: 100 chars
idCountryintegerPaese.
Dimensione massima: 11 digits
companyNamestringNome azienda.
Dimensione massima: 255 chars
companyJobstringProfessione.
Dimensione massima: 40 chars
mobilePhonestringTelefono cellulare.
Dimensione massima: 20 chars
officePhonestringTelefono ufficio.
Dimensione massima: 20 chars
phonestringTelefono.
Dimensione massima: 20 chars
faxstringFax.
Dimensione massima: 20 chars
Modelli syst - jobContract
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
userIdstringCodice persona.
Dimensione massima: 30 chars
Il valore del campo non può essere modificato.

I possibili valori possono essere ricavati dalla risorsa user.

typeIdintegerCodice tipo.
Dimensione massima: 11 digits.
Valori disponibili:
* 1(contratto_tempo_indeterminato)
* 2(contratto_tempo_determinato)
* 3(contratto_mandato_amministratore)
* 4(contratto_inserimento)
* 5(contratto_apprendistato)
* 6(contratto_tempo_parziale)
* 7(contratto_somministrazione_lavoro)
* 8(contratto_lavoro_ripartito)
* 9(contratto_a_chiamata)
* 10(contratto_a_progetto)
* 11(contratto_a_progetto)
* 12(contratto_lavoro_occasionale)
* 13(contratto_lavoro_accessorio)
* 14(tirocinio)
* 15(contratto_mandato_agenzia)
contractCodestringCodice contratto.
Dimensione massima: 40 chars
namestringNome.
Dimensione massima: 255 chars
descriptionstringDescrizione.
Dimensione massima: -1
yearGrossIncomenumberReddito lordo anno.
Dimensione massima: 6 digits
yearNetIncomenumberRedditto netto anno.
Dimensione massima: 6 digits
dayGrossIncomenumberCosto giorno.
Dimensione massima: 6 digits
dayNetIncomenumberpercepito_netto_giorno.
Dimensione massima: 11 digits
hourGrossIncomenumberCosto ora.
Dimensione massima: 6 digits
hourNetIncomenumberpercepito_netto_ora.
Dimensione massima: 11 digits
mealTktnumberBuoni pranzo anno.
Dimensione massima: 6 digits
otherCostsnumberAltri costi anno.
Dimensione massima: 6 digits
dateFromstringValido da.
formato: ISO 8601
dateTostringValido a.
formato: ISO 8601
notesstringNote.
Dimensione massima: 4096 chars
workHHPerDaysnumberUnita lavorativa.
Dimensione massima: 3 digits
Modelli syst - LocalizedText
propertytypedesc
langstringLingua. Valori disponibili:
* it: Italiano
esempio: it
textstringTesto localizzato
esempio: Testo tradotto in italiano
Modelli syst - person
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
transCodestringCodice identificativo univoco di transcodifica.
Dimensione massima: 30 chars
namestringNome.
Dimensione massima: 255 chars
surnamestringCognome.
Dimensione massima: 255 chars
companyCodestringMatricola.
Dimensione massima: 255 chars
subsidiaryIdintegerCodice sede assegnata.
Dimensione massima: 11 digits
businessUnitIdintegerCodice divisione.
Dimensione massima: 11 digits
pivastringPartita IVA.
Dimensione massima: 255 chars
pivacfstringCodice fiscale.
Dimensione massima: 255 chars
emailstringE-mail.
Dimensione massima: 255 chars
pecstringPec.
Dimensione massima: 255 chars
skypestringSkype.
Dimensione massima: 255 chars
languageIdintegerCodice lingua.
Dimensione massima: 255 digits
sexstringSesso.
Dimensione massima: 255 chars
civilStatusstringDesc n.a. for table field civilStatus.
Dimensione massima: 255 chars
addressstringIndirizzo.
Dimensione massima: 255 chars
streetNumberstringNumero civico.
Dimensione massima: 10 chars
postCodestringCAP.
Dimensione massima: 255 chars
citystringCitta.
Dimensione massima: 255 chars
countystringProvincia.
Dimensione massima: 255 chars
regionstringregione.
Dimensione massima: 255 chars
statestringStato.
Dimensione massima: 255 chars
provinceIdintegerCodice provincia.
Dimensione massima: 11 digits
regionIdintegerCodice regione.
Dimensione massima: 11 digits
countryIdintegerCodice paese.
Dimensione massima: 11 digits
mobilePhonestringCellulare.
Dimensione massima: 255 chars
officePhonestringTelefono ufficio.
Dimensione massima: 255 chars
phonestringTelefono.
Dimensione massima: 255 chars
faxstringFax.
Dimensione massima: 255 chars
webSitestringSito web.
Dimensione massima: 255 chars
birthDatestringData di nascita.
formato: ISO 8601
birthPlacestringLuogo di nascita.
Dimensione massima: 255 chars
birthProvincestringDesc n.a. for table field birthProvince.
Dimensione massima: 255 chars
birthIdProvinceintegerDesc n.a. for table field birthIdProvince.
Dimensione massima: 11 digits
birthIdCountryintegerDesc n.a. for table field birthIdCountry.
Dimensione massima: 11 digits
jobstringDesc n.a. for table field job.
Dimensione massima: 255 chars
companystringCodice azienda.
Dimensione massima: 30 chars

In fase di creazione o aggiornamento é possibile indicare il codice "interno" autogenerato oppure il codice "esterno" di transcodifica, in base a come viene valorizzato il parametro Use-Transcoded-Codes.

I possibili valori possono essere ricavati dalla risorsa company.

sharedintegerVisibile tra i contatti.
Dimensione massima: 1 digits.
Valori disponibili:
* 0(Non selezionato)
* 1(Selezioanto)
notesstringNote.
Dimensione massima: 255 chars
titlestringTitolo.
Dimensione massima: 255 chars
qualificationstringSpecializzazione.
Dimensione massima: 255 chars
Modelli syst - subsidiary
propertytypedesc
idintegerCodice identificativo, autogenerato ed univoco, del modello. Campo popolato solamente in output nelle risposte dei servizi di creazione ed interrogazione. Non viene preso in considerazione se valorizzato in input.
namestringNome.
Dimensione massima: 255 chars
addressstringIndirizzo.
Dimensione massima: 150 chars
streetNumberstringCivico.
Dimensione massima: 5 chars
zipcodestringCAP.
Dimensione massima: 25 chars
citystringCitta.
Dimensione massima: 50 chars
countystringProvincia.
Dimensione massima: 25 chars
telephonestringTelefono.
Dimensione massima: 35 chars
faxstringFax.
Dimensione massima: 35 chars
websitestringSito web.
Dimensione massima: 75 chars
emailstringE-mail.
Dimensione massima: 75 chars
Modelli syst - user
propertytypedesc
loginstringLogin.
Dimensione massima: 75 chars
passwordstringPassword.
Dimensione massima: 50 chars
expirationDatestringValido fino a.
formato: ISO 8601
userTypeIdintegerCodice tipo utente.
Dimensione massima: 11 digits
internalintegerInterno.
Dimensione massima: 11 digits
activeintegerAttivo.
Dimensione massima: 11 digits
homePagestringHome Page.
Dimensione massima: 255 chars
Attendere prego