Skip to content

Commit 234d19b

Browse files
brosenberg42jrobble
brosenberg42
and
jrobble
authored
Add info about outputObjectUri to REST API doc. (#107)
* Add info about outputObjectUri to REST API doc. * Update formatting. Co-authored-by: jrobble <jrobble@mitre.org>
1 parent 5a636d9 commit 234d19b

4 files changed

Lines changed: 107 additions & 29 deletions

File tree

‎docs/docs/html/REST-API.html‎

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@
145145
<body>
146146
<div style='page-break-after:always'>
147147
<h1>OpenMPF Workflow Manager REST API</h1>
148-
<h2>Version 4.1.0 (build 20190927)</h2>
148+
<h2>Version 4.1.0 (build 20200623)</h2>
149149
<br/>
150150
<p><i><font size="3">NOTICE</font></i></p>
151151
<p><i><font size="3">
@@ -158,7 +158,7 @@ <h2>Version 4.1.0 (build 20190927)</h2>
158158
</font></i></p>
159159
<br/>
160160
</div>
161-
<div class='footer'>Last updated on: Fri Sep 27, 2019</div>
161+
<div class='footer'>Last updated on: Tue Jun 23, 2020</div>
162162
<div class="coverHeadings">
163163
<h1>Introduction</h1>
164164
</div>
@@ -1489,7 +1489,45 @@ <h2>2. Paths</h2>
14891489
</tr>
14901490
<tr style=';background-color: #EAEAEA'>
14911491
<td class='td-alignment-small'><b>Description</b></td>
1492-
<td class='td-alignment-std'>The pipelineName should be one of the values in 'rest/pipelines', and the component associated with that pipeline must support batch processing. The media array should contain objects with a valid mediaUri. For example: http://localhost/images/image.png. Another example: file:///home/user/images/image.jpg. A callbackURL (optional) and callbackMethod (GET or POST) may be added. When the job completes, the callback will perform a GET or POST to the callbackURL with the 'jobId' and 'externalId' parameters. For example, if the callbackURL provided is 'http://api.example.com/foo', the jobId is '1', and the externalId is 'someid', then a GET callback will be: http://api.example.com/foo?jobId=1&externalId=someid. If callbackURL ends in 'foo?someparam=something', then a GET callback will be: http://api.example.com/foo?someparam=something&jobId=1&externalId=someid. If no externalId is provided, then a GET callback will be: http://api.example.com/foo?jobId=1. The body of a POST callback will always include the 'jobId' and 'externalId', even if the latter is 'null'. An optional jobProperties object contains String key-value pairs which override the pipeline's job properties for this job. An optional algorithmProperties object containing &lt;String,Map&gt; key-value pairs can override jobProperties for a specific algorithm defined in the pipeline. For algorithmProperties, the key should be the algorithm name, and the value should be a Map of String key-value pairs representing properties specific to the named algorithm. Note that the batch jobs and streaming jobs share a range of valid job ids. OpenMPF guarantees that the ids of a streaming job and a batch job will be unique. Also, note that all provided URIs must be properly encoded."<br/>
1492+
<td class='td-alignment-std'>
1493+
The pipelineName should be one of the values in 'rest/pipelines', and the component associated
1494+
with that pipeline must support batch processing. The media array should contain objects with
1495+
a valid mediaUri. Examples: http://localhost/images/image.png,
1496+
file:///home/user/images/image.jpg.
1497+
<br/>
1498+
<br/>
1499+
A callbackURL (optional) and callbackMethod (GET or POST) may be added. When the job completes,
1500+
the callback will perform a GET or POST to the callbackURL with the jobId, externalId, and
1501+
outputObjectUri parameters. For example, if the callbackURL provided is
1502+
'http://api.example.com/foo', the jobId is '1', and the externalId is 'someid', then a GET
1503+
callback will be:
1504+
<pre style="color: rgb(0, 0, 0); background-color: #ECECB4;">
1505+
http://api.example.com/foo?jobid=1&externalid=someid&outputobjecturi=file%3A%2F%2F%2Fpath%2Fto%2F1%2Fdetection.json</pre>
1506+
<br/>
1507+
If callbackURL ends in 'foo?someparam=something', then a GET callback will be:
1508+
<pre style="color: rgb(0, 0, 0); background-color: #ECECB4;">
1509+
http://api.example.com/foo?someparam=something&jobid=1&externalid=someid&outputobjecturi=file%3A%2F%2F%2Fpath%2Fto%2F1%2Fdetection.json</pre>
1510+
<br/>
1511+
If no externalId is provided, then a GET callback will be:
1512+
<pre style="color: rgb(0, 0, 0); background-color: #ECECB4;">
1513+
http://api.example.com/foo?jobid=1&outputobjecturi=file%3A%2F%2F%2Fpath%2Fto%2F1%2Fdetection.json</pre>
1514+
<br/>
1515+
The body of a POST callback will always include the 'jobId', 'externalId', and 'outputObjectUri'
1516+
even if the latter two are 'null'.
1517+
<br/>
1518+
<br/>
1519+
An optional jobProperties object contains String key-value pairs which override the pipeline's
1520+
job properties for this job. An optional algorithmProperties object containing
1521+
&lt;String,Map&gt; key-value pairs can override jobProperties for a specific algorithm defined
1522+
in the pipeline. For algorithmProperties, the key should be the algorithm name, and the value
1523+
should be a Map of String key-value pairs representing properties specific to the named
1524+
algorithm.
1525+
<br/>
1526+
<br/>
1527+
Note that the batch jobs and streaming jobs share a range of valid job ids. OpenMPF guarantees
1528+
that the ids of a streaming job and a batch job will be unique. Also, note that all provided
1529+
URIs must be properly encoded.
1530+
<br/>
14931531
<br/>
14941532
The body of a POST job creation request will be similar to this example which uses a OCV FACE DETECTION (WITH MOG MOTION PREPROCESSOR) PIPELINE. Some unrequired parameters are omitted. Note that this example makes use of overloading by jobProperties, algorithmProperties and mediaProperties:
14951533
<br/>
@@ -1519,7 +1557,8 @@ <h2>2. Paths</h2>
15191557
<pre style="color: rgb(0, 0, 0); background-color: #ECECB4;">
15201558
{
15211559
"jobId": 145,
1522-
"externalId": "555"
1560+
"externalId": "555",
1561+
"outputObjectUri": "file:///path/to/1/detection.json"
15231562
}
15241563
</pre>
15251564
</td>

‎docs/site/html/REST-API.html‎

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@
145145
<body>
146146
<div style='page-break-after:always'>
147147
<h1>OpenMPF Workflow Manager REST API</h1>
148-
<h2>Version 4.1.0 (build 20190927)</h2>
148+
<h2>Version 4.1.0 (build 20200623)</h2>
149149
<br/>
150150
<p><i><font size="3">NOTICE</font></i></p>
151151
<p><i><font size="3">
@@ -158,7 +158,7 @@ <h2>Version 4.1.0 (build 20190927)</h2>
158158
</font></i></p>
159159
<br/>
160160
</div>
161-
<div class='footer'>Last updated on: Fri Sep 27, 2019</div>
161+
<div class='footer'>Last updated on: Tue Jun 23, 2020</div>
162162
<div class="coverHeadings">
163163
<h1>Introduction</h1>
164164
</div>
@@ -1489,7 +1489,45 @@ <h2>2. Paths</h2>
14891489
</tr>
14901490
<tr style=';background-color: #EAEAEA'>
14911491
<td class='td-alignment-small'><b>Description</b></td>
1492-
<td class='td-alignment-std'>The pipelineName should be one of the values in 'rest/pipelines', and the component associated with that pipeline must support batch processing. The media array should contain objects with a valid mediaUri. For example: http://localhost/images/image.png. Another example: file:///home/user/images/image.jpg. A callbackURL (optional) and callbackMethod (GET or POST) may be added. When the job completes, the callback will perform a GET or POST to the callbackURL with the 'jobId' and 'externalId' parameters. For example, if the callbackURL provided is 'http://api.example.com/foo', the jobId is '1', and the externalId is 'someid', then a GET callback will be: http://api.example.com/foo?jobId=1&externalId=someid. If callbackURL ends in 'foo?someparam=something', then a GET callback will be: http://api.example.com/foo?someparam=something&jobId=1&externalId=someid. If no externalId is provided, then a GET callback will be: http://api.example.com/foo?jobId=1. The body of a POST callback will always include the 'jobId' and 'externalId', even if the latter is 'null'. An optional jobProperties object contains String key-value pairs which override the pipeline's job properties for this job. An optional algorithmProperties object containing &lt;String,Map&gt; key-value pairs can override jobProperties for a specific algorithm defined in the pipeline. For algorithmProperties, the key should be the algorithm name, and the value should be a Map of String key-value pairs representing properties specific to the named algorithm. Note that the batch jobs and streaming jobs share a range of valid job ids. OpenMPF guarantees that the ids of a streaming job and a batch job will be unique. Also, note that all provided URIs must be properly encoded."<br/>
1492+
<td class='td-alignment-std'>
1493+
The pipelineName should be one of the values in 'rest/pipelines', and the component associated
1494+
with that pipeline must support batch processing. The media array should contain objects with
1495+
a valid mediaUri. Examples: http://localhost/images/image.png,
1496+
file:///home/user/images/image.jpg.
1497+
<br/>
1498+
<br/>
1499+
A callbackURL (optional) and callbackMethod (GET or POST) may be added. When the job completes,
1500+
the callback will perform a GET or POST to the callbackURL with the jobId, externalId, and
1501+
outputObjectUri parameters. For example, if the callbackURL provided is
1502+
'http://api.example.com/foo', the jobId is '1', and the externalId is 'someid', then a GET
1503+
callback will be:
1504+
<pre style="color: rgb(0, 0, 0); background-color: #ECECB4;">
1505+
http://api.example.com/foo?jobid=1&externalid=someid&outputobjecturi=file%3A%2F%2F%2Fpath%2Fto%2F1%2Fdetection.json</pre>
1506+
<br/>
1507+
If callbackURL ends in 'foo?someparam=something', then a GET callback will be:
1508+
<pre style="color: rgb(0, 0, 0); background-color: #ECECB4;">
1509+
http://api.example.com/foo?someparam=something&jobid=1&externalid=someid&outputobjecturi=file%3A%2F%2F%2Fpath%2Fto%2F1%2Fdetection.json</pre>
1510+
<br/>
1511+
If no externalId is provided, then a GET callback will be:
1512+
<pre style="color: rgb(0, 0, 0); background-color: #ECECB4;">
1513+
http://api.example.com/foo?jobid=1&outputobjecturi=file%3A%2F%2F%2Fpath%2Fto%2F1%2Fdetection.json</pre>
1514+
<br/>
1515+
The body of a POST callback will always include the 'jobId', 'externalId', and 'outputObjectUri'
1516+
even if the latter two are 'null'.
1517+
<br/>
1518+
<br/>
1519+
An optional jobProperties object contains String key-value pairs which override the pipeline's
1520+
job properties for this job. An optional algorithmProperties object containing
1521+
&lt;String,Map&gt; key-value pairs can override jobProperties for a specific algorithm defined
1522+
in the pipeline. For algorithmProperties, the key should be the algorithm name, and the value
1523+
should be a Map of String key-value pairs representing properties specific to the named
1524+
algorithm.
1525+
<br/>
1526+
<br/>
1527+
Note that the batch jobs and streaming jobs share a range of valid job ids. OpenMPF guarantees
1528+
that the ids of a streaming job and a batch job will be unique. Also, note that all provided
1529+
URIs must be properly encoded.
1530+
<br/>
14931531
<br/>
14941532
The body of a POST job creation request will be similar to this example which uses a OCV FACE DETECTION (WITH MOG MOTION PREPROCESSOR) PIPELINE. Some unrequired parameters are omitted. Note that this example makes use of overloading by jobProperties, algorithmProperties and mediaProperties:
14951533
<br/>
@@ -1519,7 +1557,8 @@ <h2>2. Paths</h2>
15191557
<pre style="color: rgb(0, 0, 0); background-color: #ECECB4;">
15201558
{
15211559
"jobId": 145,
1522-
"externalId": "555"
1560+
"externalId": "555",
1561+
"outputObjectUri": "file:///path/to/1/detection.json"
15231562
}
15241563
</pre>
15251564
</td>

‎docs/site/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -388,5 +388,5 @@ <h1 id="overview">Overview</h1>
388388

389389
<!--
390390
MkDocs version : 0.16.0
391-
Build Date UTC : 2020-01-02 23:05:22
391+
Build Date UTC : 2020-06-23 19:16:56
392392
-->

‎docs/site/sitemap.xml‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<url>
66
<loc>/index.html</loc>
7-
<lastmod>2020-01-02</lastmod>
7+
<lastmod>2020-06-23</lastmod>
88
<changefreq>daily</changefreq>
99
</url>
1010

@@ -13,55 +13,55 @@
1313

1414
<url>
1515
<loc>/Release-Notes/index.html</loc>
16-
<lastmod>2020-01-02</lastmod>
16+
<lastmod>2020-06-23</lastmod>
1717
<changefreq>daily</changefreq>
1818
</url>
1919

2020
<url>
2121
<loc>/Install-Guide/index.html</loc>
22-
<lastmod>2020-01-02</lastmod>
22+
<lastmod>2020-06-23</lastmod>
2323
<changefreq>daily</changefreq>
2424
</url>
2525

2626
<url>
2727
<loc>/User-Guide/index.html</loc>
28-
<lastmod>2020-01-02</lastmod>
28+
<lastmod>2020-06-23</lastmod>
2929
<changefreq>daily</changefreq>
3030
</url>
3131

3232
<url>
3333
<loc>/Admin-Guide/index.html</loc>
34-
<lastmod>2020-01-02</lastmod>
34+
<lastmod>2020-06-23</lastmod>
3535
<changefreq>daily</changefreq>
3636
</url>
3737

3838
<url>
3939
<loc>/Node-Guide/index.html</loc>
40-
<lastmod>2020-01-02</lastmod>
40+
<lastmod>2020-06-23</lastmod>
4141
<changefreq>daily</changefreq>
4242
</url>
4343

4444
<url>
4545
<loc>/Object-Storage-Guide/index.html</loc>
46-
<lastmod>2020-01-02</lastmod>
46+
<lastmod>2020-06-23</lastmod>
4747
<changefreq>daily</changefreq>
4848
</url>
4949

5050
<url>
5151
<loc>/Contributor-Guide/index.html</loc>
52-
<lastmod>2020-01-02</lastmod>
52+
<lastmod>2020-06-23</lastmod>
5353
<changefreq>daily</changefreq>
5454
</url>
5555

5656
<url>
5757
<loc>/Development-Environment-Guide/index.html</loc>
58-
<lastmod>2020-01-02</lastmod>
58+
<lastmod>2020-06-23</lastmod>
5959
<changefreq>daily</changefreq>
6060
</url>
6161

6262
<url>
6363
<loc>/Acknowledgements/index.html</loc>
64-
<lastmod>2020-01-02</lastmod>
64+
<lastmod>2020-06-23</lastmod>
6565
<changefreq>daily</changefreq>
6666
</url>
6767

@@ -71,49 +71,49 @@
7171

7272
<url>
7373
<loc>/Component-API-Overview/index.html</loc>
74-
<lastmod>2020-01-02</lastmod>
74+
<lastmod>2020-06-23</lastmod>
7575
<changefreq>daily</changefreq>
7676
</url>
7777

7878
<url>
7979
<loc>/CPP-Batch-Component-API/index.html</loc>
80-
<lastmod>2020-01-02</lastmod>
80+
<lastmod>2020-06-23</lastmod>
8181
<changefreq>daily</changefreq>
8282
</url>
8383

8484
<url>
8585
<loc>/CPP-Streaming-Component-API/index.html</loc>
86-
<lastmod>2020-01-02</lastmod>
86+
<lastmod>2020-06-23</lastmod>
8787
<changefreq>daily</changefreq>
8888
</url>
8989

9090
<url>
9191
<loc>/Java-Batch-Component-API/index.html</loc>
92-
<lastmod>2020-01-02</lastmod>
92+
<lastmod>2020-06-23</lastmod>
9393
<changefreq>daily</changefreq>
9494
</url>
9595

9696
<url>
9797
<loc>/Python-Batch-Component-API/index.html</loc>
98-
<lastmod>2020-01-02</lastmod>
98+
<lastmod>2020-06-23</lastmod>
9999
<changefreq>daily</changefreq>
100100
</url>
101101

102102
<url>
103103
<loc>/GPU-Support-Guide/index.html</loc>
104-
<lastmod>2020-01-02</lastmod>
104+
<lastmod>2020-06-23</lastmod>
105105
<changefreq>daily</changefreq>
106106
</url>
107107

108108
<url>
109109
<loc>/Packaging-and-Registering-a-Component/index.html</loc>
110-
<lastmod>2020-01-02</lastmod>
110+
<lastmod>2020-06-23</lastmod>
111111
<changefreq>daily</changefreq>
112112
</url>
113113

114114
<url>
115115
<loc>/Feed-Forward-Guide/index.html</loc>
116-
<lastmod>2020-01-02</lastmod>
116+
<lastmod>2020-06-23</lastmod>
117117
<changefreq>daily</changefreq>
118118
</url>
119119

@@ -123,13 +123,13 @@
123123

124124
<url>
125125
<loc>/Workflow-Manager/index.html</loc>
126-
<lastmod>2020-01-02</lastmod>
126+
<lastmod>2020-06-23</lastmod>
127127
<changefreq>daily</changefreq>
128128
</url>
129129

130130
<url>
131131
<loc>/REST-API/index.html</loc>
132-
<lastmod>2020-01-02</lastmod>
132+
<lastmod>2020-06-23</lastmod>
133133
<changefreq>daily</changefreq>
134134
</url>
135135

0 commit comments

Comments
 (0)