DocsMarshal API /GanttTask/ExecuteSearch

URL: /GanttTask/ExecuteSearch

Method: POST

Descrizione

Questo metodo permette di eseguire una ricerca sulle attività di Gantt applicandone filtri e ordinamenti.

Formato richieste

Legenda:
Parametro obbligatorio
Parametro opzionale

{
'sessionId': '3234d544-55d0-41d1-8f10-1bfeb788bf01',
'idGantt': 1,
'ganttExternalId': 'classType',
'selectFieldExternalIds': 'Name;Duration;ResourceLinks.SecurityIdentityId',
'count': false,
'where':
    [
        {
'fieldExternalId': 'fieldExtId',
'condition': 'Between',
            'value': '5',
            'value2': '10',
            'valueFormat': '',
            'valueCultureInfoName': 'it-IT'
        }
    ],
'orderBy':
    [
        {
'fieldExternalId': 'field2'
'direction': 'ASC' / 'DESC'
        }
    ]
}

Note

In selectFieldExternalIds e fieldExternalId occorre inserire l'externalId del campo di interesse.
È possibile utilizzare:
- Campi dell'attività (esempio 'Name')
- Campi delle risorse di un'attività (esempio 'ResourceLinks.SecurityIdentityId')
- Campi delle dipendenze di un'attività (esempio 'Dependencies.IdGanttTaskLinked')
- Campi dei requisiti di un'attività (esempio 'ResourceRequirements.IdGanttTaskLinked')
- Campi dei collegamenti di un'attività (esempio 'Links.IdGanttTaskLinked')
- Campi delle planning categories di un'attività (esempio 'PlanningCategories.IdPlanningCategory')
Consulta l'elenco delle proprietà delle entitità
where è una lista di filtri da applicare ai valori.
Alcuni filtri non hanno bisogno di valori (e.g. isNull).
Altri hanno bisogno di un solo valore (e.g. equal) quindi si popola il campoValue
Altri hanno bisogno di due valori (e.g. between) quindi si popolano i campi Value e Value2
A fondo pagina è disponibile una lista dei possibili valori del campo where. I valori cambiano in funzione del tipo di dato su cui si applica il filtro.
ValueFormat: se ValueType è Date o DateTime, definisce il formato utilizzato. Vedere la pagina MSDN per i dettagli.
ValueCultureInfoName viene usato per parsare i campi numerici
l'API restituisce solo le attività di Gantt che soddisfano tutti i parametri di ricerca
il parametro orderby permette di specificare un ordinamento da applicare su uno o più valori prima di ritornare il risultato
Count ritorna il numero di profili trovati dalla ricerca. La struttura del JSON ritornato cambia radicalmente a seconda del valore assunto da questo parametro.

Formato risposte

Consulta questa pagina per la documentazione dell'entità di un'attività (GanttTask).
Consulta questa pagina per la documentazione delle risorse di un'attività (GanttTaskResourceLink).
Consulta questa pagina per la documentazione delle dipendenze di un'attività (GanttTaskDependency).
Consulta questa pagina per la documentazione dei requisiti delle risorse di un'attività (GanttTaskResourceRequirement).
Consulta questa pagina per la documentazione dei collegamenti di un'attività (GanttTaskLink).

{
    "Data": {
        "GanttTasks": [
            {
                "ResourceLinks": [
                    {
                        "SecurityIdentityId": 185
                    }
                ],
                "IdGantt": "11581413-6987-4fe0-90b0-88079f3c2fe2",
                "IdGanttTask": "3519f389-9067-4e63-bbd7-ee3be207cadb",
                "IdGanttTaskParent": "63061243-b664-40d5-bc60-c3e5c54c2aec",
                "Name": "Nuova attività di Gantt",
                "Description": null,
                "ExternalId": null,
                "TaskStateId": 1,
                "PlannedStartDate": "2024-07-11T14:00:00",
                "PlannedEndDate": "2024-11-01T15:10:00",
                "MaxEndDate": null,
                "MaxDuration": null,
                "InsertDt": "2024-06-11T15:08:56",
                "StartDate": "2024-10-17T16:42:22.013",
                "EndDate": "2024-10-17T16:54:13.603",
                "CompletitionDate": null,
                "Duration": 240.0,
                "ActualDuration": 2.0,
                "StartDateWaitDuration": null,
                "PlannedDelayDuration": 0.0,
                "CompletedDelayDuration": -119.0,
                "InChargeDelayDuration": -238.0,
                "MinConsecutiveDuration": null,
                "Progress": 100.0,
                "CanBeTakenInCharge": true,
                "StartDateForced": false,
                "IsParentNode": true,
                "OwnerId": 185,
                "ObjectId": null,
                "ClassTypeId": null,
                "World": null
            }
        ],
        "Count": 1
    },
    "Error": false,
    "ErrorDescription": null,
    "LoggedOut": false
}

Possibili valori per `where`

Al seguente link, è possibile visionare le condizioni accettate in base alla tipologia del campo

Di seguito è riportato il numero di valori accettati per ogni condizione

ValueType	Parametro	Numero valori
String	None	0
String	IsEqual	1
String	IsDifferent	1
String	StartWith	1
String	Contains	1
String	EndWith	1
String	IsNull	0
String	IsNotNull	0
String	IsEmpty	0
String	IsNotEmpty	0
String	IsNullOrEmpty	0
String	IsNotNullAndNotEmpty	0
String	Like	1
Int	None	0
Int	LessOf	1
Int	LessOrEqualOf	1
Int	Equal	1
Int	GreaterOrEqualOf	1
Int	GreaterOf	1
Int	DifferentOf	1
Int	Between	2
Int	IsNull	0
Int	IsNotNull	0
Int	IsNullOrZero	0
Int	IsNotNullAndNotZero	0
Int	NotIncluded	1
Bool	None	0
Bool	IsEqual	1
Bool	IsNull	1
Bool	IsNotNull	1
Date	None	0
Date	LessOf	1
Date	LessOrEqualOf	1
Date	Equal	1
Date	GreaterOrEqualOf	1
Date	GreaterOf	1
Date	DifferentOf	1
Date	Between	2
Date	IsNull	0
Date	IsNotNull	0
Date	IsNullOrZero	0
Date	IsNotNullAndNotZero	0
Date	NotIncluded	1
Date	IsBeyondThisYear	0
Date	IsLaterThisYear	0
Date	IsLaterThisMonth	0
Date	IsNextWeek	0
Date	IsTomorrow	0
Date	IsToday	0
Date	IsYesterday	0
Date	IsEarlierThisWeek	0
Date	IsLastWeek	0
Date	IsEarlierThisMonth	0
Date	IsEarlierThisYear	0
Date	IsPriorThisYear	0
Date	IsThisWeek	0

DOCSMarshal /GanttTask /ExecuteSearch