URL: /DMSearch/Execute

Method: POST

Descrizione

Questo metodo esegue una ricerca sui profili, applicando filtri e ordinamenti.

Formato richieste

Legenda:
Parametro obbligatorio
Parametro opzionale

{
    'sessionID': SID,
    'domainExternalId': 'domain',
    'classTypeExternalId': 'classType',
    'objectStatusExternalId': 'objState',
    'objectStatusExternalIds': ['objState1', 'objState2', 'objState3'],
    'fieldsToSelect': 'field1;field2;field3;field4',
    'count': true,
    'distinct': true,
    'top': 5,
    'parameters':
    [
        {
            'FieldExternalId': 'fieldExtId',
            'Condition': 'Between',
            'Value': '5',
            'Value2': '10',
            'ValueFormat': '',
            'ValueCultureInfoName': 'it-IT'
        }
    ],
    'orderby':
    [
        {
            'FieldExternalId': 'field2'
            'Direction': 'ASC' / 'DESC'
        }
    ]
}

Note

• parameters è 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 parameters. 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 i profili 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
• FieldsToSelect permette di specificare quali campi aggiuntivi del profilo si desidera recuperare, separati dal ';'.
• Count ritorna il numero di profili trovati dalla ricerca. La struttura del JSON ritornato cambia radicalmente a seconda del valore assunto da questo parametro.
• Distinct esegue la query in "SELECT DISTINCT..." ritornando quindi solamente i record differenti.
• Top permette di specificare il numero massimo di profili che devono essere restituiti.

Formato risposte (se count=false)

{
    'result':
    {
        "HasError": false,
        "Error": "",

        "Fields":
        [
                {
                      "Id": 57,
                      "Name": "field name",
                      "Label": "field label",
                      "ExternalId": "field external id",
                      "FieldType": 1,
                      "DbFieldName": "C57",
                      "LanguageId": -1
                },
                {...},
                {...}
        ],

        "Profiles":
        [
            {
                    /* system properties */
                    "DomainId": 5,
                    "ClassTypeId": 37,
                    "ObjectStateId": 14,
                    "ObjectId": "1469cf94-02d0-490b-972b-097d2a974f66",
                    "UserId": -1,
                    "Version": 0,
                    "LastUpdate": "/Date(1456807493750)/",
                    "Domain": "domainName",
                    "ClassType": "classTypeString",
                    "ObjectState": "objectStateString",
                    "Domain_ExternalId": "domainExternalId",
                    "ClassType_ExternalId": "classExternalId",
                    "ObjectState_ExternalId": "stateExternalId",
                    "InsertDt": "/Date(1455704333533)/",
                    "LanguageId": 2,

                    /* additional fields as name-value pairs */
                    "C57": "value of C57",
                    "C58": "value of C58",
                    "C59": "value of C59",
                    ...
            },
            {...},
            {...}
        ],

        "Languages":
        [
            {
                "Id": 3,
                "Name": "Italiano",
                "Code": "IT"
            },
            {...},
            {...}
        ]
    }
}

Formato risposte (se count=true)

{
    'result':
    {
        "HasError": false,
        "Error": "",
        "Count": 950
    }
}

Note

• La proprietà Languages descrive la lista dei linguaggi gestiti da DM;
• La proprietà Fields descrive i campi aggiuntivi della classe documentale. In questa proprietà si possono trovare id, nome, tipo, lingua e DbFieldName del campo;
  • Il DbFieldName è la stringa con cui verrà identificato il campo nella descrizione dei profili;
  • Il LanguageId serve per i campi di tipo MultiLanguage. Per questi campi, il LanguageId indica la lingua del campo. Il languageId si riferisce a uno dei LanguageIds descritti nella proprietà Languages della risposta dell'API;
• La proprietà Profiles descrive i profili veri e propri. Qui si possono trovare tutte le proprietà di sistema oltre ai campi aggiuntivi, descritti in fields ed identificati dal loro DbFieldName

Possibili valori per parameters

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