Demande de rapport après la publication

Demande de rapport après la publication #

Publiez une demande d'exécution d'un rapport pour une période spécifique (dateFilter).

POST /v1.0/workspaces/{WORKSPACE_ID}/rapports/{REPORT_ID}/requests

Exemple d'utilisation d'un filtre de date prédéfini #

Cette demande exécutera un rapport pour le trimestre en cours. Le corps du retour contient comme ' requestId' qui peut être utilisé pour interroger l'état du rapport et récupérer le jeu de données.

Demander #

POST <https://api.au.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports/00000000-0000-0000-0000-000000000001/requests> HTTP/1.1
Type de contenu : application/json
Autorisation : porteur {TOKEN}
Connexion : maintien en vie
{
    « reportId » : « 00000000-0000-0000-0000-000000000001 »,
    « filterId » : « 00000000-0000-0000-0000-000000000001 »,
    « dateFilter » : {
        « PresetName » : « ThisQuarter »
    },
    « ConditionsAdditionnelles » : \[]

}
Information Circle info
Le ' presetName' Il peut s'agir de l'un des < valides c1. Filtres de date prédéfinis </c1>.
Information Circle info
Le ' filterId' peut être utilisé pour appliquer un filtre prédéfini au rapport. Si elle n'est pas fournie, le filtre par défaut appliqué au rapport demandé sera utilisé.
Information Circle info
Les 'additionalConditions' peuvent être utilisées pour appliquer Additional Filters au rapport. Ces filtres complètent les paramètres spécifiés dans un filtre prédéfini.

Réponse #

HTTP/1.1 200 OK
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
{
    « données » : {
        « requestId » : « 00000000-0000-0000-0000-0000000005 »,
        « locale » : « fr-GB »,
        « reportId » : « 00000000-0000-0000-0000-0000000001 »,
        « referenceDate » : « 2025-09-22T15:23:01.0201791+00:00 »,
        « dateFilter » : {
            « presetName » : « Ce quart »,
            « presetFilterObject » : {
                « unités » : 5,
                « décalage » : 0,
                « longueur » : 1,
                « roundingMode » : 1,
                « jours de la semaine » : 127
            },
            « jours de la semaine » : 127
        },
        « startTime » : « 2025-07-01T00:00:00+01:00 »,
        « endTime » : « 2025-09-22T16:08:01.02159+01:00 »
    },
    « status » : « succès »,
    « timestamp » : « 2025-09-22T15:23:02.2982477Z »
}

Exemple d'utilisation d'une plage de dates fixe #

Cette demande exécutera un rapport pour le trimestre en cours. Le corps du retour contient comme ' requestId' qui peut être utilisé pour interroger l'état du rapport et récupérer le jeu de données.

Demander #

POST <https://api.au.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports/00000000-0000-0000-0000-000000000001/requests> HTTP/1.1
Type de contenu : application/json
Autorisation : Porteur {TOKEN}
Connexion : keep-alive
{
    « reportId » : « 00000000-0000-0000-0000-0000000001 »,
    « dateFilter » : {
       « start » : « 2025-09-26T09:00:00+01:00 »,
        « end » : « 2025-09-26T17:00:00+01:00 »
    }
}
Information Circle info
Le ' presetName' Il peut s'agir de l'un des < valides c1. Filtres de date prédéfinis </c1>.

Réponse #

HTTP/1.1 200 OK
Type de contenu : application/json ; jeu de caractères=utf-8
Contenu-Longueur : xx
{
    « données » : {
        « requestId » : « 00000000-0000-0000-0000-0000000005 »,
        « locale » : « fr-GB »,
        « reportId » : « 00000000-0000-0000-0000-0000000001 »,
        « referenceDate » : « 2025-09-22T15:23:01.0201791+00:00 »,
        « dateFilter » : {
            « start » : « 2025-09-26T09:00:00+01:00 »,
            « end » : « 2025-09-26T17:00:00+01:00 »,
            « presetFilterObject » : {
                « unités » : 5,
                « décalage » : 0,
                « longueur » : 1,
                « roundingMode » : 1,
                « jours de la semaine » : 127
            },
            « jours de la semaine » : 127
        },
        « start » : « 2025-09-26T09:00:00+01:00 »,
        « end » : « 2025-09-26T17:00:00+01:00 »
    },
    « status » : « succès »,
    « timestamp » : « 2025-09-22T15:23:02.2982477Z »
}

Erreurs #

Non autorisée #

Lorsque le jeton n'est pas fourni, qu'il n'est pas valide ou qu'il a expiré

HTTP/1.1 401 Non autorisé