Skip to content

cmsgov.provider_data.v1.client

Client 

Client(
    url: (
        str | None
    ) = "https://data.cms.gov/provider-data/api/1",
    user: str | None = None,
    password: str | None = None,
    api_key: str | None = None,
    timeout: int = 0,
    retry_number_of_attempts: int = 3,
    logger: logging.Logger | None = None,
    echo: bool = False,
)

Bases: oapi.client.Client

Parameters:

  • url (str | None, default: 'https://data.cms.gov/provider-data/api/1' ) –

    The base URL for API requests.

  • user (str | None, default: None ) –

    A user name for use with HTTP basic authentication.

  • password (str | None, default: None ) –

    A password for use with HTTP basic authentication.

  • api_key (str | None, default: None ) –

    An API key with which to authenticate requests.

  • timeout (int, default: 0 ) –

    The number of seconds before a request will timeout and throw an error. If this is 0 (the default), the system default timeout will be used.

  • retry_number_of_attempts (int, default: 3 ) –

    The number of times to retry a request which results in an error.

  • logger (logging.Logger | None, default: None ) –

    A logging.Logger to which requests should be logged.

  • echo (bool, default: False ) –

    If True, requests/responses are printed as they occur.

Source code in src/cmsgov/provider_data/v1/client.py 
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
def __init__(
    self,
    url: str | None = (
        "https://data.cms.gov/provider-data/api/1"
    ),
    user: str | None = None,
    password: str | None = None,
    api_key: str | None = None,
    timeout: int = 0,
    retry_number_of_attempts: int = 3,
    logger: Logger | None = None,
    echo: bool = False,
) -> None:
    """
    Parameters:
        url: The base URL for API requests.
        user: A user name for use with HTTP basic authentication.
        password:  A password for use with HTTP basic authentication.
        api_key: An API key with which to authenticate requests.
        timeout: The number of seconds before a request will timeout
            and throw an error. If this is 0 (the default), the system
            default timeout will be used.
        retry_number_of_attempts: The number of times to retry
            a request which results in an error.
        logger:
            A `logging.Logger` to which requests should be logged.
        echo: If `True`, requests/responses are printed as
            they occur.
    """

    super().__init__(
        url=url,
        user=user,
        password=password,
        api_key=api_key,
        timeout=timeout,
        retry_number_of_attempts=retry_number_of_attempts,
        logger=logger,
        echo=echo,
    )

get_datastore_imports 

get_datastore_imports() -> sob.abc.Dictionary

Returns a list of all stored importers, with data about their file fetcher and status.

Source code in src/cmsgov/provider_data/v1/client.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def get_datastore_imports(
    self,
) -> sob.abc.Dictionary:
    """
    Returns a list of all stored importers, with data about their file
    fetcher and status.
    """
    response: sob.abc.Readable = self.request(
        "/datastore/imports",
        method="GET",
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            sob.Dictionary,
        )
    )

post_datastore_imports 

post_datastore_imports(
    datastore_imports_post_request: cmsgov.provider_data.v1.model.DatastoreImportsPostRequest,
) -> sob.abc.Dictionary

Immediately starts the import process for a datastore.

Parameters:

Source code in src/cmsgov/provider_data/v1/client.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
def post_datastore_imports(
    self,
    datastore_imports_post_request: (
        model.DatastoreImportsPostRequest
    ),
) -> sob.abc.Dictionary:
    """
    Immediately starts the import process for a datastore.

    Parameters:
        datastore_imports_post_request:
    """
    response: sob.abc.Readable = self.request(
        "/datastore/imports",
        method="POST",
        json=datastore_imports_post_request,
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            sob.Dictionary,
        )
    )

get_datastore_imports_identifier 

get_datastore_imports_identifier(
    identifier: str,
) -> (
    cmsgov.provider_data.v1.model.DatastoreImportGetResponse
)

Returns the numbers of rows and columns, and a list of columns headers from the datastore.

Parameters:

  • identifier (str) –

    A datastore id. Note: there is an inconsistency in this API that will be addressed in the future: The expected format is different from the format supplied in /api/1/ datastore/imports.

Source code in src/cmsgov/provider_data/v1/client.py 
 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
def get_datastore_imports_identifier(
    self,
    identifier: str,
) -> model.DatastoreImportGetResponse:
    """
    Returns the numbers of rows and columns, and a list of columns headers
    from the datastore.

    Parameters:
        identifier: A datastore id. Note: there is an inconsistency in
            this API that will be addressed in the future: The expected
            format is different from the format supplied in /api/1/
            datastore/imports.
    """
    response: sob.abc.Readable = self.request(
        "/datastore/imports/{identifier}".format(**{
            "identifier": str(oapi.client.format_argument_value(
                "identifier",
                identifier,
                style="simple",
                explode=False,
            )),
        }),
        method="GET",
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.DatastoreImportGetResponse,
        )
    )

delete_datastore_imports_identifier 

delete_datastore_imports_identifier(
    identifier: str,
) -> (
    cmsgov.provider_data.v1.model.DatastoreImportDeleteResponse
)

Delete one or more datastores. If the uuid parameter is that of a resource, delete that resource. If the uuid parameter is that of a dataset, delete all resources of that dataset.

Parameters:

  • identifier (str) –

    A datastore id. Note: there is an inconsistency in this API that will be addressed in the future: The expected format is different from the format supplied in /api/1/ datastore/imports.

Source code in src/cmsgov/provider_data/v1/client.py 
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
def delete_datastore_imports_identifier(
    self,
    identifier: str,
) -> model.DatastoreImportDeleteResponse:
    """
    Delete one or more datastores. If the uuid parameter is that of a
    resource, delete that resource. If the uuid parameter is that of a
    dataset, delete all resources of that dataset.

    Parameters:
        identifier: A datastore id. Note: there is an inconsistency in
            this API that will be addressed in the future: The expected
            format is different from the format supplied in /api/1/
            datastore/imports.
    """
    response: sob.abc.Readable = self.request(
        "/datastore/imports/{identifier}".format(**{
            "identifier": str(oapi.client.format_argument_value(
                "identifier",
                identifier,
                style="simple",
                explode=False,
            )),
        }),
        method="DELETE",
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.DatastoreImportDeleteResponse,
        )
    )

get_datastore_query 

get_datastore_query(
    *,
    limit: int | None = None,
    offset: int | None = None,
    count: bool | None = None,
    results: bool | None = None,
    schema: bool | None = None,
    keys: bool | None = None,
    format_: str | None = None,
    row_ids: bool | None = None,
    resources: (
        cmsgov.provider_data.v1.model.DatastoreQueryResources
        | None
    ) = None,
    properties: (
        cmsgov.provider_data.v1.model.DatastoreQueryProperties
        | None
    ) = None,
    conditions: (
        cmsgov.provider_data.v1.model.DatastoreQueryConditions
        | None
    ) = None,
    joins: (
        cmsgov.provider_data.v1.model.DatastoreQueryJoins
        | None
    ) = None,
    groupings: (
        cmsgov.provider_data.v1.model.DatastoreQueryGroupings
        | None
    ) = None,
    sorts: (
        cmsgov.provider_data.v1.model.DatastoreQuerySorts
        | None
    ) = None
) -> (
    cmsgov.provider_data.v1.model.JsonOrCsvQueryOkResponse
    | str
)

Simple GET equivalent of a POST query. Note that parameters containing arrays or objects are not yet supported by SwaggerUI. For conditions, sorts, and other complex parameters, write your query in JSON and then convert to a nested query string. See this web tool for an example.

Parameters:

  • limit (int | None, default: None ) –
  • offset (int | None, default: None ) –
  • count (bool | None, default: None ) –
  • results (bool | None, default: None ) –
  • schema (bool | None, default: None ) –
  • keys (bool | None, default: None ) –
  • format_ (str | None, default: None ) –
  • row_ids (bool | None, default: None ) –
  • resources (cmsgov.provider_data.v1.model.DatastoreQueryResources | None, default: None ) –

    Resources to query against and aliases. Usually you will add only one resource to this array, but if performing a join, list the primary resource first and then add resources to be used in the joins array.

  • properties (cmsgov.provider_data.v1.model.DatastoreQueryProperties | None, default: None ) –
  • conditions (cmsgov.provider_data.v1.model.DatastoreQueryConditions | None, default: None ) –

    Conditions or groups of conditions for the query, bound by 'and' operator.

  • joins (cmsgov.provider_data.v1.model.DatastoreQueryJoins | None, default: None ) –

    Joins

  • groupings (cmsgov.provider_data.v1.model.DatastoreQueryGroupings | None, default: None ) –

    Properties or aliases to group results by.

  • sorts (cmsgov.provider_data.v1.model.DatastoreQuerySorts | None, default: None ) –

    Result sorting directives.

Source code in src/cmsgov/provider_data/v1/client.py 
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
def get_datastore_query(
    self,
    *,
    limit: int | None = None,
    offset: int | None = None,
    count: bool | None = None,
    results: bool | None = None,
    schema: bool | None = None,
    keys: bool | None = None,
    format_: str | None = None,
    row_ids: bool | None = None,
    resources: (
        model.DatastoreQueryResources
        | None
    ) = None,
    properties: (
        model.DatastoreQueryProperties
        | None
    ) = None,
    conditions: (
        model.DatastoreQueryConditions
        | None
    ) = None,
    joins: (
        model.DatastoreQueryJoins
        | None
    ) = None,
    groupings: (
        model.DatastoreQueryGroupings
        | None
    ) = None,
    sorts: (
        model.DatastoreQuerySorts
        | None
    ) = None,
) -> (
    model.JsonOrCsvQueryOkResponse
    | str
):
    """
    Simple GET equivalent of a POST query. Note that parameters containing
    arrays or objects are not yet supported by SwaggerUI. For conditions,
    sorts, and other complex parameters, write your query in JSON and then
    convert to a nested query string. See [this web tool](https://www.
    convertonline.io/convert/json-to-query-string) for an example.

    Parameters:
        limit:
        offset:
        count:
        results:
        schema:
        keys:
        format_:
        row_ids:
        resources: Resources to query against and aliases. Usually you
            will add only one resource to this array, but if performing a
            join, list the primary resource first and then add resources to
            be used in the joins array.
        properties:
        conditions: Conditions or groups of conditions for the query,
            bound by 'and' operator.
        joins: Joins
        groupings: Properties or aliases to group results by.
        sorts: Result sorting directives.
    """
    response: sob.abc.Readable = self.request(
        "/datastore/query",
        method="GET",
        query={
            "limit": oapi.client.format_argument_value(
                "limit",
                limit,
                style="deepObject",
                explode=True,
            ),
            "offset": oapi.client.format_argument_value(
                "offset",
                offset,
                style="deepObject",
                explode=True,
            ),
            "count": oapi.client.format_argument_value(
                "count",
                count,
                style="deepObject",
                explode=True,
            ),
            "results": oapi.client.format_argument_value(
                "results",
                results,
                style="deepObject",
                explode=True,
            ),
            "schema": oapi.client.format_argument_value(
                "schema",
                schema,
                style="deepObject",
                explode=True,
            ),
            "keys": oapi.client.format_argument_value(
                "keys",
                keys,
                style="deepObject",
                explode=True,
            ),
            "format": oapi.client.format_argument_value(
                "format",
                format_,
                style="deepObject",
                explode=True,
            ),
            "rowIds": oapi.client.format_argument_value(
                "rowIds",
                row_ids,
                style="deepObject",
                explode=True,
            ),
            "resources": oapi.client.format_argument_value(
                "resources",
                resources,
                style="deepObject",
                explode=True,
            ),
            "properties": oapi.client.format_argument_value(
                "properties",
                properties,
                style="deepObject",
                explode=True,
            ),
            "conditions": oapi.client.format_argument_value(
                "conditions",
                conditions,
                style="deepObject",
                explode=True,
            ),
            "joins": oapi.client.format_argument_value(
                "joins",
                joins,
                style="deepObject",
                explode=True,
            ),
            "groupings": oapi.client.format_argument_value(
                "groupings",
                groupings,
                style="deepObject",
                explode=True,
            ),
            "sorts": oapi.client.format_argument_value(
                "sorts",
                sorts,
                style="deepObject",
                explode=True,
            ),
        },
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response, coerce_unparseable=str),
        types=(
            model.JsonOrCsvQueryOkResponse,
            sob.StringProperty(),
        )
    )

post_datastore_query 

post_datastore_query(
    datastore_query: cmsgov.provider_data.v1.model.DatastoreQuery,
) -> (
    cmsgov.provider_data.v1.model.JsonOrCsvQueryOkResponse
    | str
)

Query one or more datastore resources

Parameters:

Source code in src/cmsgov/provider_data/v1/client.py 
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
def post_datastore_query(
    self,
    datastore_query: (
        model.DatastoreQuery
    ),
) -> (
    model.JsonOrCsvQueryOkResponse
    | str
):
    """
    Query one or more datastore resources

    Parameters:
        datastore_query: Schema for DKAN datastore queries
    """
    response: sob.abc.Readable = self.request(
        "/datastore/query",
        method="POST",
        json=datastore_query,
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response, coerce_unparseable=str),
        types=(
            model.JsonOrCsvQueryOkResponse,
            sob.StringProperty(),
        )
    )

get_datastore_query_download 

get_datastore_query_download(
    *,
    limit: int | None = None,
    offset: int | None = None,
    count: bool | None = None,
    results: bool | None = None,
    schema: bool | None = None,
    keys: bool | None = None,
    format_: str | None = None,
    row_ids: bool | None = None,
    resources: (
        cmsgov.provider_data.v1.model.DatastoreQueryResources
        | None
    ) = None,
    properties: (
        cmsgov.provider_data.v1.model.DatastoreQueryProperties
        | None
    ) = None,
    conditions: (
        cmsgov.provider_data.v1.model.DatastoreQueryConditions
        | None
    ) = None,
    joins: (
        cmsgov.provider_data.v1.model.DatastoreQueryJoins
        | None
    ) = None,
    groupings: (
        cmsgov.provider_data.v1.model.DatastoreQueryGroupings
        | None
    ) = None,
    sorts: (
        cmsgov.provider_data.v1.model.DatastoreQuerySorts
        | None
    ) = None
) -> str

Simple GET equivalent of a POST query. Note that parameters containing arrays or objects are not yet supported by SwaggerUI. For conditions, sorts, and other complex parameters, write your query in JSON and then convert to a nested query string. See this web tool for an example.

Parameters:

  • limit (int | None, default: None ) –
  • offset (int | None, default: None ) –
  • count (bool | None, default: None ) –
  • results (bool | None, default: None ) –
  • schema (bool | None, default: None ) –
  • keys (bool | None, default: None ) –
  • format_ (str | None, default: None ) –
  • row_ids (bool | None, default: None ) –
  • resources (cmsgov.provider_data.v1.model.DatastoreQueryResources | None, default: None ) –

    Resources to query against and aliases. Usually you will add only one resource to this array, but if performing a join, list the primary resource first and then add resources to be used in the joins array.

  • properties (cmsgov.provider_data.v1.model.DatastoreQueryProperties | None, default: None ) –
  • conditions (cmsgov.provider_data.v1.model.DatastoreQueryConditions | None, default: None ) –

    Conditions or groups of conditions for the query, bound by 'and' operator.

  • joins (cmsgov.provider_data.v1.model.DatastoreQueryJoins | None, default: None ) –

    Joins

  • groupings (cmsgov.provider_data.v1.model.DatastoreQueryGroupings | None, default: None ) –

    Properties or aliases to group results by.

  • sorts (cmsgov.provider_data.v1.model.DatastoreQuerySorts | None, default: None ) –

    Result sorting directives.

Source code in src/cmsgov/provider_data/v1/client.py 
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
def get_datastore_query_download(
    self,
    *,
    limit: int | None = None,
    offset: int | None = None,
    count: bool | None = None,
    results: bool | None = None,
    schema: bool | None = None,
    keys: bool | None = None,
    format_: str | None = None,
    row_ids: bool | None = None,
    resources: (
        model.DatastoreQueryResources
        | None
    ) = None,
    properties: (
        model.DatastoreQueryProperties
        | None
    ) = None,
    conditions: (
        model.DatastoreQueryConditions
        | None
    ) = None,
    joins: (
        model.DatastoreQueryJoins
        | None
    ) = None,
    groupings: (
        model.DatastoreQueryGroupings
        | None
    ) = None,
    sorts: (
        model.DatastoreQuerySorts
        | None
    ) = None,
) -> str:
    """
    Simple GET equivalent of a POST query. Note that parameters containing
    arrays or objects are not yet supported by SwaggerUI. For conditions,
    sorts, and other complex parameters, write your query in JSON and then
    convert to a nested query string. See [this web tool](https://www.
    convertonline.io/convert/json-to-query-string) for an example.

    Parameters:
        limit:
        offset:
        count:
        results:
        schema:
        keys:
        format_:
        row_ids:
        resources: Resources to query against and aliases. Usually you
            will add only one resource to this array, but if performing a
            join, list the primary resource first and then add resources to
            be used in the joins array.
        properties:
        conditions: Conditions or groups of conditions for the query,
            bound by 'and' operator.
        joins: Joins
        groupings: Properties or aliases to group results by.
        sorts: Result sorting directives.
    """
    response: sob.abc.Readable = self.request(
        "/datastore/query/download",
        method="GET",
        query={
            "limit": oapi.client.format_argument_value(
                "limit",
                limit,
                style="deepObject",
                explode=True,
            ),
            "offset": oapi.client.format_argument_value(
                "offset",
                offset,
                style="deepObject",
                explode=True,
            ),
            "count": oapi.client.format_argument_value(
                "count",
                count,
                style="deepObject",
                explode=True,
            ),
            "results": oapi.client.format_argument_value(
                "results",
                results,
                style="deepObject",
                explode=True,
            ),
            "schema": oapi.client.format_argument_value(
                "schema",
                schema,
                style="deepObject",
                explode=True,
            ),
            "keys": oapi.client.format_argument_value(
                "keys",
                keys,
                style="deepObject",
                explode=True,
            ),
            "format": oapi.client.format_argument_value(
                "format",
                format_,
                style="deepObject",
                explode=True,
            ),
            "rowIds": oapi.client.format_argument_value(
                "rowIds",
                row_ids,
                style="deepObject",
                explode=True,
            ),
            "resources": oapi.client.format_argument_value(
                "resources",
                resources,
                style="deepObject",
                explode=True,
            ),
            "properties": oapi.client.format_argument_value(
                "properties",
                properties,
                style="deepObject",
                explode=True,
            ),
            "conditions": oapi.client.format_argument_value(
                "conditions",
                conditions,
                style="deepObject",
                explode=True,
            ),
            "joins": oapi.client.format_argument_value(
                "joins",
                joins,
                style="deepObject",
                explode=True,
            ),
            "groupings": oapi.client.format_argument_value(
                "groupings",
                groupings,
                style="deepObject",
                explode=True,
            ),
            "sorts": oapi.client.format_argument_value(
                "sorts",
                sorts,
                style="deepObject",
                explode=True,
            ),
        },
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response, coerce_unparseable=str),
        types=(
            sob.StringProperty(),
        )
    )

post_datastore_query_download 

post_datastore_query_download(
    datastore_query: cmsgov.provider_data.v1.model.DatastoreQuery,
) -> str

Query one or more datastore resources for file download

Parameters:

Source code in src/cmsgov/provider_data/v1/client.py 
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
def post_datastore_query_download(
    self,
    datastore_query: (
        model.DatastoreQuery
    ),
) -> str:
    """
    Query one or more datastore resources for file download

    Parameters:
        datastore_query: Schema for DKAN datastore queries
    """
    response: sob.abc.Readable = self.request(
        "/datastore/query/download",
        method="POST",
        json=datastore_query,
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response, coerce_unparseable=str),
        types=(
            sob.StringProperty(),
        )
    )

get_datastore_query_distribution_id 

get_datastore_query_distribution_id(
    distribution_id: str,
    *,
    limit: int | None = None,
    offset: int | None = None,
    count: bool | None = None,
    results: bool | None = None,
    schema: bool | None = None,
    keys: bool | None = None,
    format_: str | None = None,
    row_ids: bool | None = None,
    resources: (
        cmsgov.provider_data.v1.model.DatastoreQueryResources
        | None
    ) = None,
    properties: (
        cmsgov.provider_data.v1.model.DatastoreQueryProperties
        | None
    ) = None,
    conditions: (
        cmsgov.provider_data.v1.model.DatastoreQueryConditions
        | None
    ) = None,
    joins: (
        cmsgov.provider_data.v1.model.DatastoreQueryJoins
        | None
    ) = None,
    groupings: (
        cmsgov.provider_data.v1.model.DatastoreQueryGroupings
        | None
    ) = None,
    sorts: (
        cmsgov.provider_data.v1.model.DatastoreQuerySorts
        | None
    ) = None
) -> (
    cmsgov.provider_data.v1.model.JsonOrCsvQueryOkResponse
    | str
)

Simple GET equivalent of a POST query. Note that parameters containing arrays or objects are not yet supported by SwaggerUI. For conditions, sorts, and other complex parameters, write your query in JSON and then convert to a nested query string. See this web tool for an example.

Parameters:

  • distribution_id (str) –

    A distribution ID

  • limit (int | None, default: None ) –
  • offset (int | None, default: None ) –
  • count (bool | None, default: None ) –
  • results (bool | None, default: None ) –
  • schema (bool | None, default: None ) –
  • keys (bool | None, default: None ) –
  • format_ (str | None, default: None ) –
  • row_ids (bool | None, default: None ) –
  • resources (cmsgov.provider_data.v1.model.DatastoreQueryResources | None, default: None ) –

    Resources to query against and aliases. Usually you will add only one resource to this array, but if performing a join, list the primary resource first and then add resources to be used in the joins array.

  • properties (cmsgov.provider_data.v1.model.DatastoreQueryProperties | None, default: None ) –
  • conditions (cmsgov.provider_data.v1.model.DatastoreQueryConditions | None, default: None ) –

    Conditions or groups of conditions for the query, bound by 'and' operator.

  • joins (cmsgov.provider_data.v1.model.DatastoreQueryJoins | None, default: None ) –

    Joins

  • groupings (cmsgov.provider_data.v1.model.DatastoreQueryGroupings | None, default: None ) –

    Properties or aliases to group results by.

  • sorts (cmsgov.provider_data.v1.model.DatastoreQuerySorts | None, default: None ) –

    Result sorting directives.

Source code in src/cmsgov/provider_data/v1/client.py 
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
def get_datastore_query_distribution_id(
    self,
    distribution_id: str,
    *,
    limit: int | None = None,
    offset: int | None = None,
    count: bool | None = None,
    results: bool | None = None,
    schema: bool | None = None,
    keys: bool | None = None,
    format_: str | None = None,
    row_ids: bool | None = None,
    resources: (
        model.DatastoreQueryResources
        | None
    ) = None,
    properties: (
        model.DatastoreQueryProperties
        | None
    ) = None,
    conditions: (
        model.DatastoreQueryConditions
        | None
    ) = None,
    joins: (
        model.DatastoreQueryJoins
        | None
    ) = None,
    groupings: (
        model.DatastoreQueryGroupings
        | None
    ) = None,
    sorts: (
        model.DatastoreQuerySorts
        | None
    ) = None,
) -> (
    model.JsonOrCsvQueryOkResponse
    | str
):
    """
    Simple GET equivalent of a POST query. Note that parameters containing
    arrays or objects are not yet supported by SwaggerUI. For conditions,
    sorts, and other complex parameters, write your query in JSON and then
    convert to a nested query string. See [this web tool](https://www.
    convertonline.io/convert/json-to-query-string) for an example.

    Parameters:
        distribution_id: A distribution ID
        limit:
        offset:
        count:
        results:
        schema:
        keys:
        format_:
        row_ids:
        resources: Resources to query against and aliases. Usually you
            will add only one resource to this array, but if performing a
            join, list the primary resource first and then add resources to
            be used in the joins array.
        properties:
        conditions: Conditions or groups of conditions for the query,
            bound by 'and' operator.
        joins: Joins
        groupings: Properties or aliases to group results by.
        sorts: Result sorting directives.
    """
    response: sob.abc.Readable = self.request(
        "/datastore/query/{distributionId}".format(**{
            "distributionId": str(oapi.client.format_argument_value(
                "distributionId",
                distribution_id,
                style="simple",
                explode=False,
            )),
        }),
        method="GET",
        query={
            "limit": oapi.client.format_argument_value(
                "limit",
                limit,
                style="deepObject",
                explode=True,
            ),
            "offset": oapi.client.format_argument_value(
                "offset",
                offset,
                style="deepObject",
                explode=True,
            ),
            "count": oapi.client.format_argument_value(
                "count",
                count,
                style="deepObject",
                explode=True,
            ),
            "results": oapi.client.format_argument_value(
                "results",
                results,
                style="deepObject",
                explode=True,
            ),
            "schema": oapi.client.format_argument_value(
                "schema",
                schema,
                style="deepObject",
                explode=True,
            ),
            "keys": oapi.client.format_argument_value(
                "keys",
                keys,
                style="deepObject",
                explode=True,
            ),
            "format": oapi.client.format_argument_value(
                "format",
                format_,
                style="deepObject",
                explode=True,
            ),
            "rowIds": oapi.client.format_argument_value(
                "rowIds",
                row_ids,
                style="deepObject",
                explode=True,
            ),
            "resources": oapi.client.format_argument_value(
                "resources",
                resources,
                style="deepObject",
                explode=True,
            ),
            "properties": oapi.client.format_argument_value(
                "properties",
                properties,
                style="deepObject",
                explode=True,
            ),
            "conditions": oapi.client.format_argument_value(
                "conditions",
                conditions,
                style="deepObject",
                explode=True,
            ),
            "joins": oapi.client.format_argument_value(
                "joins",
                joins,
                style="deepObject",
                explode=True,
            ),
            "groupings": oapi.client.format_argument_value(
                "groupings",
                groupings,
                style="deepObject",
                explode=True,
            ),
            "sorts": oapi.client.format_argument_value(
                "sorts",
                sorts,
                style="deepObject",
                explode=True,
            ),
        },
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response, coerce_unparseable=str),
        types=(
            model.JsonOrCsvQueryOkResponse,
            sob.StringProperty(),
        )
    )

post_datastore_query_distribution_id 

post_datastore_query_distribution_id(
    datastore_resource_query: cmsgov.provider_data.v1.model.DatastoreResourceQuery,
    distribution_id: str,
) -> (
    cmsgov.provider_data.v1.model.JsonOrCsvQueryOkResponse
    | str
)

Query a single datastore resource

Parameters:

  • datastore_resource_query (cmsgov.provider_data.v1.model.DatastoreResourceQuery) –

    Schema for DKAN datastore queries. When querying against a specific resource, the "resource" property is always optional. If you want to set it explicitly, note that it will be aliased to simply "t".

  • distribution_id (str) –

    A distribution ID

Source code in src/cmsgov/provider_data/v1/client.py 
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
def post_datastore_query_distribution_id(
    self,
    datastore_resource_query: (
        model.DatastoreResourceQuery
    ),
    distribution_id: str,
) -> (
    model.JsonOrCsvQueryOkResponse
    | str
):
    """
    Query a single datastore resource

    Parameters:
        datastore_resource_query: Schema for DKAN datastore queries.
            When querying against a specific resource, the "resource"
            property is always optional. If you want to set it explicitly,
            note that it will be aliased to simply "t".
        distribution_id: A distribution ID
    """
    response: sob.abc.Readable = self.request(
        "/datastore/query/{distributionId}".format(**{
            "distributionId": str(oapi.client.format_argument_value(
                "distributionId",
                distribution_id,
                style="simple",
                explode=False,
            )),
        }),
        method="POST",
        json=datastore_resource_query,
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response, coerce_unparseable=str),
        types=(
            model.JsonOrCsvQueryOkResponse,
            sob.StringProperty(),
        )
    )

get_datastore_query_dataset_id_index 

get_datastore_query_dataset_id_index(
    dataset_id: str,
    index: int,
    *,
    limit: int | None = None,
    offset: int | None = None,
    count: bool | None = None,
    results: bool | None = None,
    schema: bool | None = None,
    keys: bool | None = None,
    format_: str | None = None,
    row_ids: bool | None = None,
    resources: (
        cmsgov.provider_data.v1.model.DatastoreQueryResources
        | None
    ) = None,
    properties: (
        cmsgov.provider_data.v1.model.DatastoreQueryProperties
        | None
    ) = None,
    conditions: (
        cmsgov.provider_data.v1.model.DatastoreQueryConditions
        | None
    ) = None,
    joins: (
        cmsgov.provider_data.v1.model.DatastoreQueryJoins
        | None
    ) = None,
    groupings: (
        cmsgov.provider_data.v1.model.DatastoreQueryGroupings
        | None
    ) = None,
    sorts: (
        cmsgov.provider_data.v1.model.DatastoreQuerySorts
        | None
    ) = None
) -> (
    cmsgov.provider_data.v1.model.JsonOrCsvQueryOkResponse
    | str
)

Simple GET equivalent of a POST query -- see the POST endpoint documentation for full query schema. A few basic parameters are provided here as examples. For more reliable queries, write your query in JSON and then convert to a query string. See this web tool for an example.

Parameters:

  • dataset_id (str) –

    A dataset ID

  • index (int) –

    The index of a distribution in a dataset's distribution array. For instance, the first distribution in a dataset would have an index of "0," the second would have "1", etc.

  • limit (int | None, default: None ) –
  • offset (int | None, default: None ) –
  • count (bool | None, default: None ) –
  • results (bool | None, default: None ) –
  • schema (bool | None, default: None ) –
  • keys (bool | None, default: None ) –
  • format_ (str | None, default: None ) –
  • row_ids (bool | None, default: None ) –
  • resources (cmsgov.provider_data.v1.model.DatastoreQueryResources | None, default: None ) –

    Resources to query against and aliases. Usually you will add only one resource to this array, but if performing a join, list the primary resource first and then add resources to be used in the joins array.

  • properties (cmsgov.provider_data.v1.model.DatastoreQueryProperties | None, default: None ) –
  • conditions (cmsgov.provider_data.v1.model.DatastoreQueryConditions | None, default: None ) –

    Conditions or groups of conditions for the query, bound by 'and' operator.

  • joins (cmsgov.provider_data.v1.model.DatastoreQueryJoins | None, default: None ) –

    Joins

  • groupings (cmsgov.provider_data.v1.model.DatastoreQueryGroupings | None, default: None ) –

    Properties or aliases to group results by.

  • sorts (cmsgov.provider_data.v1.model.DatastoreQuerySorts | None, default: None ) –

    Result sorting directives.

Source code in src/cmsgov/provider_data/v1/client.py 
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
def get_datastore_query_dataset_id_index(
    self,
    dataset_id: str,
    index: int,
    *,
    limit: int | None = None,
    offset: int | None = None,
    count: bool | None = None,
    results: bool | None = None,
    schema: bool | None = None,
    keys: bool | None = None,
    format_: str | None = None,
    row_ids: bool | None = None,
    resources: (
        model.DatastoreQueryResources
        | None
    ) = None,
    properties: (
        model.DatastoreQueryProperties
        | None
    ) = None,
    conditions: (
        model.DatastoreQueryConditions
        | None
    ) = None,
    joins: (
        model.DatastoreQueryJoins
        | None
    ) = None,
    groupings: (
        model.DatastoreQueryGroupings
        | None
    ) = None,
    sorts: (
        model.DatastoreQuerySorts
        | None
    ) = None,
) -> (
    model.JsonOrCsvQueryOkResponse
    | str
):
    """
    Simple GET equivalent of a POST query -- see the POST endpoint
    documentation for full query schema. A few basic parameters are
    provided here as examples. For more reliable queries, write your query
    in JSON and then convert to a query string. See [this web tool](https:/
    /www.convertonline.io/convert/json-to-query-string) for an example.

    Parameters:
        dataset_id: A dataset ID
        index: The index of a distribution in a dataset's distribution
            array. For instance, the first distribution in a dataset would
            have an index of "0," the second would have "1", etc.
        limit:
        offset:
        count:
        results:
        schema:
        keys:
        format_:
        row_ids:
        resources: Resources to query against and aliases. Usually you
            will add only one resource to this array, but if performing a
            join, list the primary resource first and then add resources to
            be used in the joins array.
        properties:
        conditions: Conditions or groups of conditions for the query,
            bound by 'and' operator.
        joins: Joins
        groupings: Properties or aliases to group results by.
        sorts: Result sorting directives.
    """
    response: sob.abc.Readable = self.request(
        "/datastore/query/{datasetId}/{index}".format(**{
            "datasetId": str(oapi.client.format_argument_value(
                "datasetId",
                dataset_id,
                style="simple",
                explode=False,
            )),
            "index": str(oapi.client.format_argument_value(
                "index",
                index,
                style="simple",
                explode=False,
            )),
        }),
        method="GET",
        query={
            "limit": oapi.client.format_argument_value(
                "limit",
                limit,
                style="deepObject",
                explode=True,
            ),
            "offset": oapi.client.format_argument_value(
                "offset",
                offset,
                style="deepObject",
                explode=True,
            ),
            "count": oapi.client.format_argument_value(
                "count",
                count,
                style="deepObject",
                explode=True,
            ),
            "results": oapi.client.format_argument_value(
                "results",
                results,
                style="deepObject",
                explode=True,
            ),
            "schema": oapi.client.format_argument_value(
                "schema",
                schema,
                style="deepObject",
                explode=True,
            ),
            "keys": oapi.client.format_argument_value(
                "keys",
                keys,
                style="deepObject",
                explode=True,
            ),
            "format": oapi.client.format_argument_value(
                "format",
                format_,
                style="deepObject",
                explode=True,
            ),
            "rowIds": oapi.client.format_argument_value(
                "rowIds",
                row_ids,
                style="deepObject",
                explode=True,
            ),
            "resources": oapi.client.format_argument_value(
                "resources",
                resources,
                style="deepObject",
                explode=True,
            ),
            "properties": oapi.client.format_argument_value(
                "properties",
                properties,
                style="deepObject",
                explode=True,
            ),
            "conditions": oapi.client.format_argument_value(
                "conditions",
                conditions,
                style="deepObject",
                explode=True,
            ),
            "joins": oapi.client.format_argument_value(
                "joins",
                joins,
                style="deepObject",
                explode=True,
            ),
            "groupings": oapi.client.format_argument_value(
                "groupings",
                groupings,
                style="deepObject",
                explode=True,
            ),
            "sorts": oapi.client.format_argument_value(
                "sorts",
                sorts,
                style="deepObject",
                explode=True,
            ),
        },
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response, coerce_unparseable=str),
        types=(
            model.JsonOrCsvQueryOkResponse,
            sob.StringProperty(),
        )
    )

post_datastore_query_dataset_id_index 

post_datastore_query_dataset_id_index(
    datastore_resource_query: cmsgov.provider_data.v1.model.DatastoreResourceQuery,
    dataset_id: str,
    index: int,
) -> (
    cmsgov.provider_data.v1.model.JsonOrCsvQueryOkResponse
    | str
)

Query a single datastore resource

Parameters:

  • datastore_resource_query (cmsgov.provider_data.v1.model.DatastoreResourceQuery) –

    Schema for DKAN datastore queries. When querying against a specific resource, the "resource" property is always optional. If you want to set it explicitly, note that it will be aliased to simply "t".

  • dataset_id (str) –

    A dataset ID

  • index (int) –

    The index of a distribution in a dataset's distribution array. For instance, the first distribution in a dataset would have an index of "0," the second would have "1", etc.

Source code in src/cmsgov/provider_data/v1/client.py 
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
def post_datastore_query_dataset_id_index(
    self,
    datastore_resource_query: (
        model.DatastoreResourceQuery
    ),
    dataset_id: str,
    index: int,
) -> (
    model.JsonOrCsvQueryOkResponse
    | str
):
    """
    Query a single datastore resource

    Parameters:
        datastore_resource_query: Schema for DKAN datastore queries.
            When querying against a specific resource, the "resource"
            property is always optional. If you want to set it explicitly,
            note that it will be aliased to simply "t".
        dataset_id: A dataset ID
        index: The index of a distribution in a dataset's distribution
            array. For instance, the first distribution in a dataset would
            have an index of "0," the second would have "1", etc.
    """
    response: sob.abc.Readable = self.request(
        "/datastore/query/{datasetId}/{index}".format(**{
            "datasetId": str(oapi.client.format_argument_value(
                "datasetId",
                dataset_id,
                style="simple",
                explode=False,
            )),
            "index": str(oapi.client.format_argument_value(
                "index",
                index,
                style="simple",
                explode=False,
            )),
        }),
        method="POST",
        json=datastore_resource_query,
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response, coerce_unparseable=str),
        types=(
            model.JsonOrCsvQueryOkResponse,
            sob.StringProperty(),
        )
    )

get_datastore_query_distribution_id_download 

get_datastore_query_distribution_id_download(
    distribution_id: str,
    *,
    format_: str | None = None,
    resources: (
        cmsgov.provider_data.v1.model.DatastoreQueryResources
        | None
    ) = None,
    properties: (
        cmsgov.provider_data.v1.model.DatastoreQueryProperties
        | None
    ) = None,
    conditions: (
        cmsgov.provider_data.v1.model.DatastoreQueryConditions
        | None
    ) = None,
    joins: (
        cmsgov.provider_data.v1.model.DatastoreQueryJoins
        | None
    ) = None,
    groupings: (
        cmsgov.provider_data.v1.model.DatastoreQueryGroupings
        | None
    ) = None,
    sorts: (
        cmsgov.provider_data.v1.model.DatastoreQuerySorts
        | None
    ) = None
) -> str

Like the other datastore query GET endpoints, additional parameters may be added by serializing a query JSON object (documented in the POST endpoints) into a query string.

Parameters:

  • distribution_id (str) –

    A distribution ID

  • format_ (str | None, default: None ) –

    Response format. Currently, only csv is supported.

  • resources (cmsgov.provider_data.v1.model.DatastoreQueryResources | None, default: None ) –

    Resources to query against and aliases. Usually you will add only one resource to this array, but if performing a join, list the primary resource first and then add resources to be used in the joins array.

  • properties (cmsgov.provider_data.v1.model.DatastoreQueryProperties | None, default: None ) –
  • conditions (cmsgov.provider_data.v1.model.DatastoreQueryConditions | None, default: None ) –

    Conditions or groups of conditions for the query, bound by 'and' operator.

  • joins (cmsgov.provider_data.v1.model.DatastoreQueryJoins | None, default: None ) –

    Joins

  • groupings (cmsgov.provider_data.v1.model.DatastoreQueryGroupings | None, default: None ) –

    Properties or aliases to group results by.

  • sorts (cmsgov.provider_data.v1.model.DatastoreQuerySorts | None, default: None ) –

    Result sorting directives.

Source code in src/cmsgov/provider_data/v1/client.py 
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
def get_datastore_query_distribution_id_download(
    self,
    distribution_id: str,
    *,
    format_: str | None = None,
    resources: (
        model.DatastoreQueryResources
        | None
    ) = None,
    properties: (
        model.DatastoreQueryProperties
        | None
    ) = None,
    conditions: (
        model.DatastoreQueryConditions
        | None
    ) = None,
    joins: (
        model.DatastoreQueryJoins
        | None
    ) = None,
    groupings: (
        model.DatastoreQueryGroupings
        | None
    ) = None,
    sorts: (
        model.DatastoreQuerySorts
        | None
    ) = None,
) -> str:
    """
    Like the other datastore query GET endpoints, additional parameters may
    be added by serializing a query JSON object (documented in the POST
    endpoints) into a query string.

    Parameters:
        distribution_id: A distribution ID
        format_: Response format. Currently, only csv is supported.
        resources: Resources to query against and aliases. Usually you
            will add only one resource to this array, but if performing a
            join, list the primary resource first and then add resources to
            be used in the joins array.
        properties:
        conditions: Conditions or groups of conditions for the query,
            bound by 'and' operator.
        joins: Joins
        groupings: Properties or aliases to group results by.
        sorts: Result sorting directives.
    """
    response: sob.abc.Readable = self.request(
        "/datastore/query/{distributionId}/download".format(**{
            "distributionId": str(oapi.client.format_argument_value(
                "distributionId",
                distribution_id,
                style="simple",
                explode=False,
            )),
        }),
        method="GET",
        query={
            "format": oapi.client.format_argument_value(
                "format",
                format_,
                style="deepObject",
                explode=True,
            ),
            "resources": oapi.client.format_argument_value(
                "resources",
                resources,
                style="deepObject",
                explode=True,
            ),
            "properties": oapi.client.format_argument_value(
                "properties",
                properties,
                style="deepObject",
                explode=True,
            ),
            "conditions": oapi.client.format_argument_value(
                "conditions",
                conditions,
                style="deepObject",
                explode=True,
            ),
            "joins": oapi.client.format_argument_value(
                "joins",
                joins,
                style="deepObject",
                explode=True,
            ),
            "groupings": oapi.client.format_argument_value(
                "groupings",
                groupings,
                style="deepObject",
                explode=True,
            ),
            "sorts": oapi.client.format_argument_value(
                "sorts",
                sorts,
                style="deepObject",
                explode=True,
            ),
        },
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response, coerce_unparseable=str),
        types=(
            sob.StringProperty(),
        )
    )

get_datastore_query_dataset_id_index_download 

get_datastore_query_dataset_id_index_download(
    dataset_id: str,
    index: int,
    *,
    format_: str | None = None,
    resources: (
        cmsgov.provider_data.v1.model.DatastoreQueryResources
        | None
    ) = None,
    properties: (
        cmsgov.provider_data.v1.model.DatastoreQueryProperties
        | None
    ) = None,
    conditions: (
        cmsgov.provider_data.v1.model.DatastoreQueryConditions
        | None
    ) = None,
    joins: (
        cmsgov.provider_data.v1.model.DatastoreQueryJoins
        | None
    ) = None,
    groupings: (
        cmsgov.provider_data.v1.model.DatastoreQueryGroupings
        | None
    ) = None,
    sorts: (
        cmsgov.provider_data.v1.model.DatastoreQuerySorts
        | None
    ) = None
) -> str

Like the other datastore query GET endpoints, additional parameters may be added by serializing a query JSON object (documented in the POST endpoints) into a query string.

Parameters:

  • dataset_id (str) –

    A dataset ID

  • index (int) –

    The index of a distribution in a dataset's distribution array. For instance, the first distribution in a dataset would have an index of "0," the second would have "1", etc.

  • format_ (str | None, default: None ) –

    Response format. Currently, only csv is supported.

  • resources (cmsgov.provider_data.v1.model.DatastoreQueryResources | None, default: None ) –

    Resources to query against and aliases. Usually you will add only one resource to this array, but if performing a join, list the primary resource first and then add resources to be used in the joins array.

  • properties (cmsgov.provider_data.v1.model.DatastoreQueryProperties | None, default: None ) –
  • conditions (cmsgov.provider_data.v1.model.DatastoreQueryConditions | None, default: None ) –

    Conditions or groups of conditions for the query, bound by 'and' operator.

  • joins (cmsgov.provider_data.v1.model.DatastoreQueryJoins | None, default: None ) –

    Joins

  • groupings (cmsgov.provider_data.v1.model.DatastoreQueryGroupings | None, default: None ) –

    Properties or aliases to group results by.

  • sorts (cmsgov.provider_data.v1.model.DatastoreQuerySorts | None, default: None ) –

    Result sorting directives.

Source code in src/cmsgov/provider_data/v1/client.py 
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
def get_datastore_query_dataset_id_index_download(
    self,
    dataset_id: str,
    index: int,
    *,
    format_: str | None = None,
    resources: (
        model.DatastoreQueryResources
        | None
    ) = None,
    properties: (
        model.DatastoreQueryProperties
        | None
    ) = None,
    conditions: (
        model.DatastoreQueryConditions
        | None
    ) = None,
    joins: (
        model.DatastoreQueryJoins
        | None
    ) = None,
    groupings: (
        model.DatastoreQueryGroupings
        | None
    ) = None,
    sorts: (
        model.DatastoreQuerySorts
        | None
    ) = None,
) -> str:
    """
    Like the other datastore query GET endpoints, additional parameters may
    be added by serializing a query JSON object (documented in the POST
    endpoints) into a query string.

    Parameters:
        dataset_id: A dataset ID
        index: The index of a distribution in a dataset's distribution
            array. For instance, the first distribution in a dataset would
            have an index of "0," the second would have "1", etc.
        format_: Response format. Currently, only csv is supported.
        resources: Resources to query against and aliases. Usually you
            will add only one resource to this array, but if performing a
            join, list the primary resource first and then add resources to
            be used in the joins array.
        properties:
        conditions: Conditions or groups of conditions for the query,
            bound by 'and' operator.
        joins: Joins
        groupings: Properties or aliases to group results by.
        sorts: Result sorting directives.
    """
    response: sob.abc.Readable = self.request(
        "/datastore/query/{datasetId}/{index}/download".format(**{
            "datasetId": str(oapi.client.format_argument_value(
                "datasetId",
                dataset_id,
                style="simple",
                explode=False,
            )),
            "index": str(oapi.client.format_argument_value(
                "index",
                index,
                style="simple",
                explode=False,
            )),
        }),
        method="GET",
        query={
            "format": oapi.client.format_argument_value(
                "format",
                format_,
                style="deepObject",
                explode=True,
            ),
            "resources": oapi.client.format_argument_value(
                "resources",
                resources,
                style="deepObject",
                explode=True,
            ),
            "properties": oapi.client.format_argument_value(
                "properties",
                properties,
                style="deepObject",
                explode=True,
            ),
            "conditions": oapi.client.format_argument_value(
                "conditions",
                conditions,
                style="deepObject",
                explode=True,
            ),
            "joins": oapi.client.format_argument_value(
                "joins",
                joins,
                style="deepObject",
                explode=True,
            ),
            "groupings": oapi.client.format_argument_value(
                "groupings",
                groupings,
                style="deepObject",
                explode=True,
            ),
            "sorts": oapi.client.format_argument_value(
                "sorts",
                sorts,
                style="deepObject",
                explode=True,
            ),
        },
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response, coerce_unparseable=str),
        types=(
            sob.StringProperty(),
        )
    )

get_datastore_sql 

get_datastore_sql(
    query: str, *, show_db_columns: bool | None = None
) -> cmsgov.provider_data.v1.model.DatastoreSqlGetResponse

Interact with resources in the datastore using an SQL-like syntax.

Parameters:

  • query (str) –

    A SQL-like query. A SELECT using the show_db_columns parameter will make it easier to build queries against the data as it returns columns without spaces and in some cases, truncated names where the human readable column header is very long. /api/1/datastore/sql?query=[SELECT * FROM DATASTORE_UUID][ LIMIT 1 OFFSET 0];&show_db_columns You can then build the SELECT part of the query. Do not use spaces between its arguments. /api/1/datastore/sql?query=[SELECT a,b,c, FROM DATASTORE_UUID] WHERE can use any column in the data. /api/1/datastore/sql?query=[SELECT a,b FROM DATASTORE_UUID][ WHERE c = "CCC"];&show_db_columns LIMIT and OFFSET allow you to get more than the 500 record limit, by using successive queries: /api/1/datastore/sql?query=[SELECT a,b,c FROM DATASTORE_UUID][ WHERE d = "CCC"][LIMIT 500 OFFSET 0];&show_db_columns /api/1/datastore/sql?query=[SELECT a,b,c FROM DATASTORE_UUID][ WHERE d = "DDD"][LIMIT 500 OFFSET 500];&show_db_columns Note: SELECT, WHERE and LIMIT...OFFSET clauses must each be included within brackets [ ].

  • show_db_columns (bool | None, default: None ) –

    Add &show_db_columns to return columns without spaces and in some cases, truncated names where the human readable column header is very long.

Source code in src/cmsgov/provider_data/v1/client.py 
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
def get_datastore_sql(
    self,
    query: str,
    *,
    show_db_columns: bool | None = None,
) -> model.DatastoreSqlGetResponse:
    """
    Interact with resources in the datastore using an SQL-like syntax.

    Parameters:
        query: A SQL-like query.
            A `SELECT` using the `show_db_columns` parameter will make it
            easier to build queries against the data as
            it returns columns without spaces and in some cases, truncated
            names where the human readable column header
            is very long.
            `/api/1/datastore/sql?query=[SELECT * FROM DATASTORE_UUID][
            LIMIT 1 OFFSET 0];&show_db_columns`
            You can then build the `SELECT` part of the query. Do not use
            spaces between its arguments.
            `/api/1/datastore/sql?query=[SELECT a,b,c, FROM DATASTORE_UUID]
            `
            `WHERE` can use any column in the data.
            `/api/1/datastore/sql?query=[SELECT a,b FROM DATASTORE_UUID][
            WHERE c = "CCC"];&show_db_columns`
            `LIMIT` and `OFFSET` allow you to get more than the 500 record
            limit, by using successive queries:
            `/api/1/datastore/sql?query=[SELECT a,b,c FROM DATASTORE_UUID][
            WHERE d = "CCC"][LIMIT 500 OFFSET 0];&show_db_columns`
            `/api/1/datastore/sql?query=[SELECT a,b,c FROM DATASTORE_UUID][
            WHERE d = "DDD"][LIMIT 500 OFFSET 500];&show_db_columns`
            Note: `SELECT`, `WHERE` and `LIMIT...OFFSET` clauses must each
            be included within brackets `[ ]`.
        show_db_columns: Add `&show_db_columns` to return columns
            without spaces and in some cases, truncated names where the
            human
            readable column header is very long.
    """
    response: sob.abc.Readable = self.request(
        "/datastore/sql",
        method="GET",
        query={
            "query": oapi.client.format_argument_value(
                "query",
                query,
                style="form",
                explode=True,
            ),
            "show_db_columns": oapi.client.format_argument_value(
                "show_db_columns",
                show_db_columns,
                style="form",
                explode=True,
            ),
        },
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.DatastoreSqlGetResponse,
        )
    )

get_harvest_plans 

get_harvest_plans() -> (
    cmsgov.provider_data.v1.model.HarvestPlansGetResponse
)

Lists the identifiers of all registered harvests.

Source code in src/cmsgov/provider_data/v1/client.py 
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
def get_harvest_plans(
    self,
) -> model.HarvestPlansGetResponse:
    """
    Lists the identifiers of all registered harvests.
    """
    response: sob.abc.Readable = self.request(
        "/harvest/plans",
        method="GET",
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.HarvestPlansGetResponse,
        )
    )

post_harvest_plans 

post_harvest_plans(
    harvest_plan: cmsgov.provider_data.v1.model.HarvestPlan,
) -> cmsgov.provider_data.v1.model.HarvestPlansPostResponse

Registers a new harvest, after validating against our schema.

Parameters:

Source code in src/cmsgov/provider_data/v1/client.py 
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
def post_harvest_plans(
    self,
    harvest_plan: (
        model.HarvestPlan
    ),
) -> model.HarvestPlansPostResponse:
    """
    Registers a new harvest, after validating against our schema.

    Parameters:
        harvest_plan:
    """
    response: sob.abc.Readable = self.request(
        "/harvest/plans",
        method="POST",
        json=harvest_plan,
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.HarvestPlansPostResponse,
        )
    )

get_harvest_plans_plan_id 

get_harvest_plans_plan_id(
    plan_id: str,
) -> cmsgov.provider_data.v1.model.HarvestPlan

Get the json plan of a registered harvest, based on the its harvest id.

Parameters:

  • plan_id (str) –

    A harvest plan identifier

Source code in src/cmsgov/provider_data/v1/client.py 
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
def get_harvest_plans_plan_id(
    self,
    plan_id: str,
) -> model.HarvestPlan:
    """
    Get the json plan of a registered harvest, based on the its harvest id.

    Parameters:
        plan_id: A harvest plan identifier
    """
    response: sob.abc.Readable = self.request(
        "/harvest/plans/{plan_id}".format(**{
            "plan_id": str(oapi.client.format_argument_value(
                "plan_id",
                plan_id,
                style="simple",
                explode=False,
            )),
        }),
        method="GET",
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.HarvestPlan,
        )
    )

get_harvest_runs_run_id 

get_harvest_runs_run_id(run_id: str) -> sob.abc.Dictionary

Gives information about a previous run for a specific harvest run.

Parameters:

  • run_id (str) –

    A harvest run identifier

Source code in src/cmsgov/provider_data/v1/client.py 
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
def get_harvest_runs_run_id(
    self,
    run_id: str,
) -> sob.abc.Dictionary:
    """
    Gives information about a previous run for a specific harvest run.

    Parameters:
        run_id: A harvest run identifier
    """
    response: sob.abc.Readable = self.request(
        "/harvest/runs/{run_id}".format(**{
            "run_id": str(oapi.client.format_argument_value(
                "run_id",
                run_id,
                style="simple",
                explode=False,
            )),
        }),
        method="GET",
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            sob.Dictionary,
        )
    )

get_harvest_runs 

get_harvest_runs(
    plan: str,
) -> cmsgov.provider_data.v1.model.HarvestRunsGetResponse

Lists the identifiers (timestamps) of previous runs for a particular harvest id.

Parameters:

  • plan (str) –

    A harvest plan identifier

Source code in src/cmsgov/provider_data/v1/client.py 
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
def get_harvest_runs(
    self,
    plan: str,
) -> model.HarvestRunsGetResponse:
    """
    Lists the identifiers (timestamps) of previous runs for a particular
    harvest id.

    Parameters:
        plan: A harvest plan identifier
    """
    response: sob.abc.Readable = self.request(
        "/harvest/runs",
        method="GET",
        query={
            "plan": oapi.client.format_argument_value(
                "plan",
                plan,
                style="form",
                explode=True,
            ),
        },
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.HarvestRunsGetResponse,
        )
    )

post_harvest_runs 

post_harvest_runs(
    harvest_runs_post_request: cmsgov.provider_data.v1.model.HarvestRunsPostRequest,
) -> cmsgov.provider_data.v1.model.HarvestRunsPostResponse

Runs a harvest for a specific plan identifier inside json object payload.

Parameters:

Source code in src/cmsgov/provider_data/v1/client.py 
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
def post_harvest_runs(
    self,
    harvest_runs_post_request: (
        model.HarvestRunsPostRequest
    ),
) -> model.HarvestRunsPostResponse:
    """
    Runs a harvest for a specific plan identifier inside json object
    payload.

    Parameters:
        harvest_runs_post_request:
    """
    response: sob.abc.Readable = self.request(
        "/harvest/runs",
        method="POST",
        json=harvest_runs_post_request,
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.HarvestRunsPostResponse,
        )
    )

get_metastore_schemas 

get_metastore_schemas() -> sob.abc.Dictionary

Get list of all schemas

Source code in src/cmsgov/provider_data/v1/client.py 
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
def get_metastore_schemas(
    self,
) -> sob.abc.Dictionary:
    """
    Get list of all schemas
    """
    response: sob.abc.Readable = self.request(
        "/metastore/schemas",
        method="GET",
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            sob.Dictionary,
        )
    )

get_metastore_schemas_schema_id 

get_metastore_schemas_schema_id(
    schema_id: str,
) -> sob.abc.Dictionary

Get a specific schema

Parameters:

  • schema_id (str) –

    The name a of a specific schema. For instance, " dataset."

Source code in src/cmsgov/provider_data/v1/client.py 
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
def get_metastore_schemas_schema_id(
    self,
    schema_id: str,
) -> sob.abc.Dictionary:
    """
    Get a specific schema

    Parameters:
        schema_id: The name a of a specific schema. For instance, "
            dataset."
    """
    response: sob.abc.Readable = self.request(
        "/metastore/schemas/{schema_id}".format(**{
            "schema_id": str(oapi.client.format_argument_value(
                "schema_id",
                schema_id,
                style="simple",
                explode=False,
            )),
        }),
        method="GET",
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            sob.Dictionary,
        )
    )

get_metastore_schemas_schema_id_items 

get_metastore_schemas_schema_id_items(
    schema_id: str,
    *,
    show_reference_ids: bool | None = None
) -> (
    cmsgov.provider_data.v1.model.MetastoreSchemasSchemaIdItemsGetResponse
)

Get all items for a specific schema (e.g., "dataset")

Parameters:

  • schema_id (str) –

    The name a of a specific schema. For instance, " dataset."

  • show_reference_ids (bool | None, default: None ) –

    Metastore objects often include references to other objects stored in other schemas. These references are usually hidden in responses. Some identifiers are necessary to work with other API endpoints (e.g. datastore endpoints may require the distribution identifier). Add ?show-reference-ids to show the identifiers generated by DKAN.

Source code in src/cmsgov/provider_data/v1/client.py 
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
def get_metastore_schemas_schema_id_items(
    self,
    schema_id: str,
    *,
    show_reference_ids: bool | None = None,
) -> model.MetastoreSchemasSchemaIdItemsGetResponse:
    """
    Get all items for a specific schema (e.g., "dataset")

    Parameters:
        schema_id: The name a of a specific schema. For instance, "
            dataset."
        show_reference_ids: Metastore objects often include references
            to other objects stored in other schemas. These references are
            usually hidden in responses. Some identifiers are necessary to
            work with other API endpoints (e.g. datastore endpoints may
            require the distribution identifier). Add `?show-reference-ids`
            to show the identifiers generated by DKAN.
    """
    response: sob.abc.Readable = self.request(
        "/metastore/schemas/{schema_id}/items".format(**{
            "schema_id": str(oapi.client.format_argument_value(
                "schema_id",
                schema_id,
                style="simple",
                explode=False,
            )),
        }),
        method="GET",
        query={
            "show-reference-ids": oapi.client.format_argument_value(
                "show-reference-ids",
                show_reference_ids,
                style="form",
                explode=True,
            ),
        },
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.MetastoreSchemasSchemaIdItemsGetResponse,
        )
    )

get_metastore_schemas_schema_id_items_identifier_revisions 

get_metastore_schemas_schema_id_items_identifier_revisions(
    schema_id: str, identifier: str
) -> (
    cmsgov.provider_data.v1.model.MetastoreSchemasSchemaIdItemsIdentifierRevisionsGetResponse
)

Get all revisions for an item.

Parameters:

  • schema_id (str) –

    The name a of a specific schema. For instance, " dataset."

  • identifier (str) –

    A dataset identifier

Source code in src/cmsgov/provider_data/v1/client.py 
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
def get_metastore_schemas_schema_id_items_identifier_revisions(
    self,
    schema_id: str,
    identifier: str,
) -> model.MetastoreSchemasSchemaIdItemsIdentifierRevisionsGetResponse:
    """
    Get all revisions for an item.

    Parameters:
        schema_id: The name a of a specific schema. For instance, "
            dataset."
        identifier: A dataset identifier
    """
    response: sob.abc.Readable = self.request(
        "/metastore/schemas/{schema_id}/items/{identifier}/revisions".format(**{  # noqa: E501
            "schema_id": str(oapi.client.format_argument_value(
                "schema_id",
                schema_id,
                style="simple",
                explode=False,
            )),
            "identifier": str(oapi.client.format_argument_value(
                "identifier",
                identifier,
                style="simple",
                explode=False,
            )),
        }),
        method="GET",
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.MetastoreSchemasSchemaIdItemsIdentifierRevisionsGetResponse,  # noqa: E501
        )
    )

post_metastore_schemas_schema_id_items_identifier_revisions 

post_metastore_schemas_schema_id_items_identifier_revisions(
    metastore_schema_revision_post_request: cmsgov.provider_data.v1.model.MetastoreSchemaRevisionPostRequest,
    schema_id: str,
    identifier: str,
) -> cmsgov.provider_data.v1.model.MetastoreWriteResponse

Create new item revision/state.

Parameters:

  • metastore_schema_revision_post_request (cmsgov.provider_data.v1.model.MetastoreSchemaRevisionPostRequest) –
  • schema_id (str) –

    The name a of a specific schema. For instance, " dataset."

  • identifier (str) –

    A dataset identifier

Source code in src/cmsgov/provider_data/v1/client.py 
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
def post_metastore_schemas_schema_id_items_identifier_revisions(
    self,
    metastore_schema_revision_post_request: (
        model.MetastoreSchemaRevisionPostRequest
    ),
    schema_id: str,
    identifier: str,
) -> model.MetastoreWriteResponse:
    """
    Create new item revision/state.

    Parameters:
        metastore_schema_revision_post_request:
        schema_id: The name a of a specific schema. For instance, "
            dataset."
        identifier: A dataset identifier
    """
    response: sob.abc.Readable = self.request(
        "/metastore/schemas/{schema_id}/items/{identifier}/revisions".format(**{  # noqa: E501
            "schema_id": str(oapi.client.format_argument_value(
                "schema_id",
                schema_id,
                style="simple",
                explode=False,
            )),
            "identifier": str(oapi.client.format_argument_value(
                "identifier",
                identifier,
                style="simple",
                explode=False,
            )),
        }),
        method="POST",
        json=metastore_schema_revision_post_request,
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.MetastoreWriteResponse,
        )
    )

get_metastore_schemas_schema_id_items_identifier_revisions_revision_id 

get_metastore_schemas_schema_id_items_identifier_revisions_revision_id(
    schema_id: str, identifier: str, revision_id: str
) -> cmsgov.provider_data.v1.model.MetastoreRevision

Get all revisions for an item.

Parameters:

  • schema_id (str) –

    The name a of a specific schema. For instance, " dataset."

  • identifier (str) –

    A dataset identifier

  • revision_id (str) –

    Revision identifier. Use "identifier" property from revision object.

Source code in src/cmsgov/provider_data/v1/client.py 
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
def get_metastore_schemas_schema_id_items_identifier_revisions_revision_id(
    self,
    schema_id: str,
    identifier: str,
    revision_id: str,
) -> model.MetastoreRevision:
    """
    Get all revisions for an item.

    Parameters:
        schema_id: The name a of a specific schema. For instance, "
            dataset."
        identifier: A dataset identifier
        revision_id: Revision identifier. Use "identifier" property
            from revision object.
    """
    response: sob.abc.Readable = self.request(
        "/metastore/schemas/{schema_id}/items/{identifier}/revisions/{revision_id}".format(**{  # noqa: E501
            "schema_id": str(oapi.client.format_argument_value(
                "schema_id",
                schema_id,
                style="simple",
                explode=False,
            )),
            "identifier": str(oapi.client.format_argument_value(
                "identifier",
                identifier,
                style="simple",
                explode=False,
            )),
            "revision_id": str(oapi.client.format_argument_value(
                "revision_id",
                revision_id,
                style="simple",
                explode=False,
            )),
        }),
        method="GET",
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.MetastoreRevision,
        )
    )

get_metastore_schemas_dataset_items 

get_metastore_schemas_dataset_items(
    *, show_reference_ids: bool | None = None
) -> cmsgov.provider_data.v1.model.Datasets

Get all datasets.

Parameters:

  • show_reference_ids (bool | None, default: None ) –

    Metastore objects often include references to other objects stored in other schemas. These references are usually hidden in responses. Some identifiers are necessary to work with other API endpoints (e.g. datastore endpoints may require the distribution identifier). Add ?show-reference-ids to show the identifiers generated by DKAN.

Source code in src/cmsgov/provider_data/v1/client.py 
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
def get_metastore_schemas_dataset_items(
    self,
    *,
    show_reference_ids: bool | None = None,
) -> model.Datasets:
    """
    Get all datasets.

    Parameters:
        show_reference_ids: Metastore objects often include references
            to other objects stored in other schemas. These references are
            usually hidden in responses. Some identifiers are necessary to
            work with other API endpoints (e.g. datastore endpoints may
            require the distribution identifier). Add `?show-reference-ids`
            to show the identifiers generated by DKAN.
    """
    response: sob.abc.Readable = self.request(
        "/metastore/schemas/dataset/items",
        method="GET",
        query={
            "show-reference-ids": oapi.client.format_argument_value(
                "show-reference-ids",
                show_reference_ids,
                style="form",
                explode=True,
            ),
        },
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.Datasets,
        )
    )

put_metastore_schemas_dataset_items 

put_metastore_schemas_dataset_items(
    dataset: cmsgov.provider_data.v1.model.Dataset,
    identifier: str,
) -> cmsgov.provider_data.v1.model.MetastoreWriteResponse

Object will be completely replaced; optional properties not included in the request will be deleted.

Automatic example not yet available; try retrieving a dataset via GET, changing values, and pasting to test. If no item exists with the provided identifier, it will be created.

Parameters:

  • dataset (cmsgov.provider_data.v1.model.Dataset) –

    The metadata format for all federal open data. Validates a single JSON object entry (as opposed to entire Data.json catalog).

  • identifier (str) –

    A dataset identifier

Source code in src/cmsgov/provider_data/v1/client.py 
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
def put_metastore_schemas_dataset_items(
    self,
    dataset: (
        model.Dataset
    ),
    identifier: str,
) -> model.MetastoreWriteResponse:
    """
    Object will be completely replaced; optional properties not included in
    the request will be deleted.

    Automatic example not yet available; try retrieving a dataset via GET,
    changing values, and pasting to test. If no item exists with the
    provided identifier, it will be created.

    Parameters:
        dataset: The metadata format for all federal open data.
            Validates a single JSON object entry (as opposed to entire
            Data.json catalog).
        identifier: A dataset identifier
    """
    response: sob.abc.Readable = self.request(
        "/metastore/schemas/dataset/items".format(**{
            "identifier": str(oapi.client.format_argument_value(
                "identifier",
                identifier,
                style="simple",
                explode=False,
            )),
        }),
        method="PUT",
        json=dataset,
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.MetastoreWriteResponse,
        )
    )

patch_metastore_schemas_dataset_items 

patch_metastore_schemas_dataset_items(
    metastore_schemas_dataset_items_patch_request: cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequest,
    identifier: str,
) -> cmsgov.provider_data.v1.model.MetastoreWriteResponse

Values provided will replace existing values, but required values may be omitted.

Automatic example not yet available; try retrieving a dataset via GET, changing values, removing unchanged properties, and pasting to test.

Parameters:

  • metastore_schemas_dataset_items_patch_request (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequest) –

    The metadata format for all federal open data. Validates a single JSON object entry (as opposed to entire Data.json catalog).

  • identifier (str) –

    A dataset identifier

Source code in src/cmsgov/provider_data/v1/client.py 
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
def patch_metastore_schemas_dataset_items(
    self,
    metastore_schemas_dataset_items_patch_request: (
        model.MetastoreSchemasDatasetItemsPatchRequest
    ),
    identifier: str,
) -> model.MetastoreWriteResponse:
    """
    Values provided will replace existing values, but required values may
    be omitted.

    Automatic example not yet available; try retrieving a dataset via GET,
    changing values, removing unchanged properties, and pasting to test.

    Parameters:
        metastore_schemas_dataset_items_patch_request: The metadata
            format for all federal open data. Validates a single JSON
            object entry (as opposed to entire Data.json catalog).
        identifier: A dataset identifier
    """
    response: sob.abc.Readable = self.request(
        "/metastore/schemas/dataset/items".format(**{
            "identifier": str(oapi.client.format_argument_value(
                "identifier",
                identifier,
                style="simple",
                explode=False,
            )),
        }),
        method="PATCH",
        json=metastore_schemas_dataset_items_patch_request,
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.MetastoreWriteResponse,
        )
    )

get_metastore_schemas_dataset_items_identifier 

get_metastore_schemas_dataset_items_identifier(
    identifier: str,
    *,
    show_reference_ids: bool | None = None
) -> cmsgov.provider_data.v1.model.Dataset

Get a single dataset.

Parameters:

  • identifier (str) –

    A dataset identifier

  • show_reference_ids (bool | None, default: None ) –

    Metastore objects often include references to other objects stored in other schemas. These references are usually hidden in responses. Some identifiers are necessary to work with other API endpoints (e.g. datastore endpoints may require the distribution identifier). Add ?show-reference-ids to show the identifiers generated by DKAN.

Source code in src/cmsgov/provider_data/v1/client.py 
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
def get_metastore_schemas_dataset_items_identifier(
    self,
    identifier: str,
    *,
    show_reference_ids: bool | None = None,
) -> model.Dataset:
    """
    Get a single dataset.

    Parameters:
        identifier: A dataset identifier
        show_reference_ids: Metastore objects often include references
            to other objects stored in other schemas. These references are
            usually hidden in responses. Some identifiers are necessary to
            work with other API endpoints (e.g. datastore endpoints may
            require the distribution identifier). Add `?show-reference-ids`
            to show the identifiers generated by DKAN.
    """
    response: sob.abc.Readable = self.request(
        "/metastore/schemas/dataset/items/{identifier}".format(**{
            "identifier": str(oapi.client.format_argument_value(
                "identifier",
                identifier,
                style="simple",
                explode=False,
            )),
        }),
        method="GET",
        query={
            "show-reference-ids": oapi.client.format_argument_value(
                "show-reference-ids",
                show_reference_ids,
                style="form",
                explode=True,
            ),
        },
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.Dataset,
        )
    )

put_metastore_schemas_dataset_items_identifier 

put_metastore_schemas_dataset_items_identifier(
    dataset: cmsgov.provider_data.v1.model.Dataset,
    identifier: str,
) -> cmsgov.provider_data.v1.model.MetastoreWriteResponse

Object will be completely replaced; optional properties not included in the request will be deleted.

Automatic example not yet available; try retrieving a dataset via GET, changing values, and pasting to test. If no item exists with the provided identifier, it will be created.

Parameters:

  • dataset (cmsgov.provider_data.v1.model.Dataset) –

    The metadata format for all federal open data. Validates a single JSON object entry (as opposed to entire Data.json catalog).

  • identifier (str) –

    A dataset identifier

Source code in src/cmsgov/provider_data/v1/client.py 
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
def put_metastore_schemas_dataset_items_identifier(
    self,
    dataset: (
        model.Dataset
    ),
    identifier: str,
) -> model.MetastoreWriteResponse:
    """
    Object will be completely replaced; optional properties not included in
    the request will be deleted.

    Automatic example not yet available; try retrieving a dataset via GET,
    changing values, and pasting to test. If no item exists with the
    provided identifier, it will be created.

    Parameters:
        dataset: The metadata format for all federal open data.
            Validates a single JSON object entry (as opposed to entire
            Data.json catalog).
        identifier: A dataset identifier
    """
    response: sob.abc.Readable = self.request(
        "/metastore/schemas/dataset/items/{identifier}".format(**{
            "identifier": str(oapi.client.format_argument_value(
                "identifier",
                identifier,
                style="simple",
                explode=False,
            )),
        }),
        method="PUT",
        json=dataset,
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.MetastoreWriteResponse,
        )
    )

patch_metastore_schemas_dataset_items_identifier 

patch_metastore_schemas_dataset_items_identifier(
    metastore_schemas_dataset_items_identifier_patch_request: cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequest,
    identifier: str,
) -> cmsgov.provider_data.v1.model.MetastoreWriteResponse

Values provided will replace existing values, but required values may be omitted.

Automatic example not yet available; try retrieving a dataset via GET, changing values, removing unchanged properties, and pasting to test.

Parameters:

  • metastore_schemas_dataset_items_identifier_patch_request (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequest) –

    The metadata format for all federal open data. Validates a single JSON object entry (as opposed to entire Data.json catalog).

  • identifier (str) –

    A dataset identifier

Source code in src/cmsgov/provider_data/v1/client.py 
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
def patch_metastore_schemas_dataset_items_identifier(
    self,
    metastore_schemas_dataset_items_identifier_patch_request: (
        model.MetastoreSchemasDatasetItemsIdentifierPatchRequest
    ),
    identifier: str,
) -> model.MetastoreWriteResponse:
    """
    Values provided will replace existing values, but required values may
    be omitted.

    Automatic example not yet available; try retrieving a dataset via GET,
    changing values, removing unchanged properties, and pasting to test.

    Parameters:
        metastore_schemas_dataset_items_identifier_patch_request: The
            metadata format for all federal open data. Validates a single
            JSON object entry (as opposed to entire Data.json catalog).
        identifier: A dataset identifier
    """
    response: sob.abc.Readable = self.request(
        "/metastore/schemas/dataset/items/{identifier}".format(**{
            "identifier": str(oapi.client.format_argument_value(
                "identifier",
                identifier,
                style="simple",
                explode=False,
            )),
        }),
        method="PATCH",
        json=metastore_schemas_dataset_items_identifier_patch_request,
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.MetastoreWriteResponse,
        )
    )

get_search(
    *,
    fulltext: str | None = None,
    page: int | None = None,
    page_size: int | None = None,
    sort: (
        cmsgov.provider_data.v1.model.SortSearch | None
    ) = None,
    sort_order: (
        cmsgov.provider_data.v1.model.SortSearchOrder | None
    ) = None,
    facets: str | None = None,
    theme: str | None = None,
    keyword: str | None = None
) -> cmsgov.provider_data.v1.model.SearchGetResponse

Search description.

Parameters:

  • fulltext (str | None, default: None ) –

    Full-text search to run against any metadata fields indexed for fulltext searches.

  • page (int | None, default: None ) –

    The page of the result set.

  • page_size (int | None, default: None ) –

    How many results per page.

  • sort (cmsgov.provider_data.v1.model.SortSearch | None, default: None ) –

    Which property to sort results on. Available properties : access_level, description, keyword, modified, theme, title, title_string, search_api_relevance

  • sort_order (cmsgov.provider_data.v1.model.SortSearchOrder | None, default: None ) –

    Sort results in ascending or descending order. Allowed values: asc, desc

  • facets (str | None, default: None ) –

    Request information on facets. Pass a comma-separated list to get specific facets. Pass an empty value or "0" for no facet infrmation. Omit this parameter to get all facet information.

  • theme (str | None, default: None ) –

    Filter results using theme facet.

  • keyword (str | None, default: None ) –

    Filter results using keyword</ em> facet.

Source code in src/cmsgov/provider_data/v1/client.py 
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
def get_search(
    self,
    *,
    fulltext: str | None = None,
    page: int | None = None,
    page_size: int | None = None,
    sort: (
        model.SortSearch
        | None
    ) = None,
    sort_order: (
        model.SortSearchOrder
        | None
    ) = None,
    facets: str | None = None,
    theme: str | None = None,
    keyword: str | None = None,
) -> model.SearchGetResponse:
    """
    Search description.

    Parameters:
        fulltext: Full-text search to run against any metadata fields
            indexed for fulltext searches.
        page: The page of the result set.
        page_size: How many results per page.
        sort: Which property to sort results on. Available properties
            : <em class="placeholder">access_level, description, keyword,
            modified, theme, title, title_string, search_api_relevance</em>
        sort_order: Sort results in ascending or descending order.
            Allowed values: <em>asc, desc</em>
        facets: Request information on facets. Pass a comma-separated
            list to get specific facets. Pass an empty value or "0" for no
            facet infrmation. Omit this parameter to get all facet
            information.
        theme: Filter results using <em class="placeholder">theme</em>
            facet.
        keyword: Filter results using <em class="placeholder">keyword</
            em> facet.
    """
    response: sob.abc.Readable = self.request(
        "/search",
        method="GET",
        query={
            "fulltext": oapi.client.format_argument_value(
                "fulltext",
                fulltext,
                style="form",
                explode=True,
            ),
            "page": oapi.client.format_argument_value(
                "page",
                page,
                style="form",
                explode=True,
            ),
            "page-size": oapi.client.format_argument_value(
                "page-size",
                page_size,
                style="form",
                explode=True,
            ),
            "sort": oapi.client.format_argument_value(
                "sort",
                sort,
                style="form",
                explode=False,
            ),
            "sort-order": oapi.client.format_argument_value(
                "sort-order",
                sort_order,
                style="form",
                explode=False,
            ),
            "facets": oapi.client.format_argument_value(
                "facets",
                facets,
                style="form",
                explode=False,
            ),
            "theme": oapi.client.format_argument_value(
                "theme",
                theme,
                style="form",
                explode=True,
            ),
            "keyword": oapi.client.format_argument_value(
                "keyword",
                keyword,
                style="form",
                explode=True,
            ),
        },
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.SearchGetResponse,
        )
    )

get_search_facets 

get_search_facets() -> (
    cmsgov.provider_data.v1.model.SearchFacetsGetResponse
)

Retrieve search facet information

Source code in src/cmsgov/provider_data/v1/client.py 
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
def get_search_facets(
    self,
) -> model.SearchFacetsGetResponse:
    """
    Retrieve search facet information
    """
    response: sob.abc.Readable = self.request(
        "/search/facets",
        method="GET",
    )
    return sob.unmarshal(  # type: ignore
        sob.deserialize(response),
        types=(
            model.SearchFacetsGetResponse,
        )
    )