1"use strict";(globalThis.webpackChunkregardsoss_github_io=globalThis.webpackChunkregardsoss_github_io||[]).push([[4055],{46687(e,n,s){s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>d,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"development/services/processing/api-guides/rest/backend-processing-monitoring-api","title":"REGARDS Processing Monitoring API","description":"GET /monitoring/executions","source":"@site/versioned_docs/version-2.3.1/development/services/processing/api-guides/rest/monitoring-api.md","sourceDirName":"development/services/processing/api-guides/rest","slug":"/development/backend/services/processing/api/monitoring/","permalink":"/docs/development/backend/services/processing/api/monitoring/","draft":false,"unlisted":false,"editUrl":"https://github.com/RegardsOss/RegardsOss.github.io/edit/master/versioned_docs/version-2.3.1/development/services/processing/api-guides/rest/monitoring-api.md","tags":[],"version":"2.3.1","sidebarPosition":2,"frontMatter":{"id":"backend-processing-monitoring-api","title":"REGARDS Processing Monitoring API","sidebar_label":"Monitoring","sidebar_position":2,"slug":"/development/backend/services/processing/api/monitoring/"},"sidebar":"dev","previous":{"title":"Batch","permalink":"/docs/development/backend/services/processing/api/batch/"},"next":{"title":"Process","permalink":"/docs/development/backend/services/processing/api/process/"}}');var t=s(74848),r=s(28453);const d={id:"backend-processing-monitoring-api",title:"REGARDS Processing Monitoring API",sidebar_label:"Monitoring",sidebar_position:2,slug:"/development/backend/services/processing/api/monitoring/"},o=void 0,c={},l=[{value:"GET <code>/monitoring/executions</code>",id:"get-monitoringexecutions",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Responses",id:"responses",level:3}];function a(e){const n={code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.h2,{id:"get-monitoringexecutions",children:["GET ",(0,t.jsx)(n.code,{children:"/monitoring/executions"})]}),"\n",(0,t.jsx)(n.p,{children:"List the executions present in the processing database, filtered by diverse criteria."}),"\n",(0,t.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{children:"Name"}),(0,t.jsx)(n.th,{children:"Located in"}),(0,t.jsx)(n.th,{children:"Description"}),(0,t.jsx)(n.th,{children:"Required"}),(0,t.jsx)(n.th,{children:"Schema"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"tenant"}),(0,t.jsx)(n.td,{children:"query"}),(0,t.jsx)(n.td,{children:"The tenant"}),(0,t.jsx)(n.td,{children:"Yes"}),(0,t.jsx)(n.td,{children:"string"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"status"}),(0,t.jsx)(n.td,{children:"query"}),(0,t.jsx)(n.td,{children:"The list of execution status"}),(0,t.jsx)(n.td,{children:"Yes"}),(0,t.jsx)(n.td,{children:"[ RUNNING, SUCCESS, FAILURE, TIMED_OUT ]"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"userEmail"}),(0,t.jsx)(n.td,{children:"query"}),(0,t.jsx)(n.td,{children:"The optional user who launched the executions"}),(0,t.jsx)(n.td,{children:"No"}),(0,t.jsx)(n.td,{children:"string"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"processBusinessId"}),(0,t.jsx)(n.td,{children:"query"}),(0,t.jsx)(n.td,{children:"The optional process business ID the executions refer to"}),(0,t.jsx)(n.td,{children:"No"}),(0,t.jsx)(n.td,{children:"string"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"from"}),(0,t.jsx)(n.td,{children:"query"}),(0,t.jsx)(n.td,{children:"The execution 'last updated' minimum timestamp"}),(0,t.jsx)(n.td,{children:"No"}),(0,t.jsx)(n.td,{children:"string"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"to"}),(0,t.jsx)(n.td,{children:"query"}),(0,t.jsx)(n.td,{children:"The execution 'last updated' maximum timestamp"}),(0,t.jsx)(n.td,{children:"No"}),(0,t.jsx)(n.td,{children:"string"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"page"}),(0,t.jsx)(n.td,{children:"query"}),(0,t.jsx)(n.td,{children:"The page number"}),(0,t.jsx)(n.td,{children:"No"}),(0,t.jsx)(n.td,{children:"integer"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"size"}),(0,t.jsx)(n.td,{children:"query"}),(0,t.jsx)(n.td,{children:"The page size"}),(0,t.jsx)(n.td,{children:"No"}),(0,t.jsx)(n.td,{children:"integer"})]})]})]}),"\n",(0,t.jsx)(n.h3,{id:"responses",children:"Responses"}),"\n",(0,t.jsxs)(n.table,{children:[(0,t.jsx)(n.thead,{children:(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.th,{children:"Code"}),(0,t.jsx)(n.th,{children:"Description"})]})}),(0,t.jsxs)(n.tbody,{children:[(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"200"}),(0,t.jsx)(n.td,{children:"default response"})]}),(0,t.jsxs)(n.tr,{children:[(0,t.jsx)(n.td,{children:"500"}),(0,t.jsx)(n.td,{children:"default response"})]})]})]}),"\n",(0,t.jsx)(n.p,{children:"Sample 200 response body:"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-json",children:'{\n "links": [\n {\n "rel": "string",\n "href": "string",\n "hreflang": "string",\n "media": "string",\n "title": "string",\n "type": "string",\n "deprecation": "string",\n "profile": "string",\n "name": "string"\n }\n ],\n "content": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "executionCorrelationId": "string",\n "batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "batchCorrelationId": "string",\n "expectedDuration": 0,\n "inputFiles": [{}
1],\n "steps": [{}],\n "tenant": "string",\n "userName": "string",\n "processBusinessId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "created": "2020-12-31T00:00:00Z",\n "lastUpdated": "2020-12-31T00:00:00Z",\n "version": 0,\n "persisted": true,\n "processName": "string",\n "links": [\n {\n "rel": "string",\n "href": "string",\n "hreflang": "string",\n "media": "string",\n "title": "string",\n "type": "string",\n "deprecation": "string",\n "profile": "string",\n "name": "string"\n }\n ]\n }\n ],\n "page": {\n "size": 0,\n "totalElements": 0,\n "totalPages": 0,\n "number": 0\n }\n}\n'})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},28453(e,n,s){s.d(n,{R:()=>d,x:()=>o});var i=s(96540);const t={},r=i.createContext(t);function d(e){const n=i.useContext(r);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.