nominal-api 0.1240.0

API bindings for the Nominal platform
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

use conjure_http::endpoint;
/// The Job Service is responsible for returning information about jobs for checklist executions.
#[conjure_http::conjure_endpoints(name = "JobService", use_legacy_error_serialization)]
pub trait JobService {
    /// Fetches the job report for a job RID. Throws ResourcesNotFound if no job exists with this job RID.
    #[endpoint(
        method = GET,
        path = "/jobs/v1/{jobRid}/job-report",
        name = "getJobReport",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn get_job_report(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "jobRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "jobRid",
            safe
        )]
        job_rid: super::super::super::super::super::objects::scout::checks::api::JobRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::JobReport,
        conjure_http::private::Error,
    >;
    /// Fetches the job reports for a set of job RIDs. Omits any job reports the user is not permitted to see from
    /// the response.
    #[endpoint(
        method = POST,
        path = "/jobs/v1/batch-get-job-reports",
        name = "batchGetJobReports",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn batch_get_job_reports(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
        request: super::super::super::super::super::objects::scout::checks::api::BatchGetJobReportsRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::BatchGetJobReportsResponse,
        conjure_http::private::Error,
    >;
}
/// The Job Service is responsible for returning information about jobs for checklist executions.
#[conjure_http::conjure_endpoints(name = "JobService", use_legacy_error_serialization)]
pub trait AsyncJobService {
    /// Fetches the job report for a job RID. Throws ResourcesNotFound if no job exists with this job RID.
    #[endpoint(
        method = GET,
        path = "/jobs/v1/{jobRid}/job-report",
        name = "getJobReport",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_job_report(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "jobRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "jobRid",
            safe
        )]
        job_rid: super::super::super::super::super::objects::scout::checks::api::JobRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::JobReport,
        conjure_http::private::Error,
    >;
    /// Fetches the job reports for a set of job RIDs. Omits any job reports the user is not permitted to see from
    /// the response.
    #[endpoint(
        method = POST,
        path = "/jobs/v1/batch-get-job-reports",
        name = "batchGetJobReports",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn batch_get_job_reports(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
        request: super::super::super::super::super::objects::scout::checks::api::BatchGetJobReportsRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::BatchGetJobReportsResponse,
        conjure_http::private::Error,
    >;
}
/// The Job Service is responsible for returning information about jobs for checklist executions.
#[conjure_http::conjure_endpoints(
    name = "JobService",
    use_legacy_error_serialization,
    local
)]
pub trait LocalAsyncJobService {
    /// Fetches the job report for a job RID. Throws ResourcesNotFound if no job exists with this job RID.
    #[endpoint(
        method = GET,
        path = "/jobs/v1/{jobRid}/job-report",
        name = "getJobReport",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_job_report(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "jobRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "jobRid",
            safe
        )]
        job_rid: super::super::super::super::super::objects::scout::checks::api::JobRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::JobReport,
        conjure_http::private::Error,
    >;
    /// Fetches the job reports for a set of job RIDs. Omits any job reports the user is not permitted to see from
    /// the response.
    #[endpoint(
        method = POST,
        path = "/jobs/v1/batch-get-job-reports",
        name = "batchGetJobReports",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn batch_get_job_reports(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
        request: super::super::super::super::super::objects::scout::checks::api::BatchGetJobReportsRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::BatchGetJobReportsResponse,
        conjure_http::private::Error,
    >;
}