Skip to contents

Get publications

Usage

get_publications(
  ees_environment = NULL,
  api_version = NULL,
  search = NULL,
  page_size = 40,
  page = NULL,
  verbose = FALSE
)

Arguments

ees_environment

EES ees_environment to connect to: "dev", "test", "preprod" or "prod"

api_version

EES API version

String for filtering the publication list for publication titles and summaries containing the search string provided (strings separated by spaces are combined with OR logic).

page_size

Number of results to return in a single query

page

Page number of query results to return

verbose

Run with additional contextual messaging. Logical, default = FALSE

Value

Data frame listing all available publications

Examples

get_publications()
#>                                     id                            title
#> 1 2c75dd3d-03e8-4f23-eeb2-08dce39219d4           API data sets' Testing
#> 2 9f68da54-6b0c-4979-372d-08dd138decea Attendance dashboard-API testing
#> 3 25d0e40b-643a-4f73-3ae5-08dcf1c4d57f        Data sets for API testing
#> 4 73f32592-39a8-4296-62fe-08dcd7dcf7ed                     Public API 2
#> 5 f715cb51-1f0a-4fa0-0df9-08dce77dad59  Task 2 - second time publishing
#>                               slug
#> 1            api-data-sets-testing
#> 2 attendance-dashboard-api-testing
#> 3        data-sets-for-api-testing
#> 4                     public-api-2
#> 5    task-2-second-time-publishing
#>                                                                     summary
#> 1                                        Testing for the first time on Test
#> 2                    Data sets for testing the EES API with a DfE dashboard
#> 3 A collection of example data sets for testing the public facing API with.
#> 4                                                                       sdf
#> 5                                           Task 2 - second time publishing
#>                       lastPublished
#> 1 2024-10-28T14:15:41.0624984+00:00
#> 2  2025-01-07T15:08:52.187975+00:00
#> 3 2024-11-07T09:26:48.7531176+00:00
#> 4 2025-01-08T17:32:30.9784334+00:00
#> 5 2024-10-08T10:21:06.9135415+00:00
get_publications(search = "attendance")
#>                                     id                            title
#> 1 9f68da54-6b0c-4979-372d-08dd138decea Attendance dashboard-API testing
#>                               slug
#> 1 attendance-dashboard-api-testing
#>                                                  summary
#> 1 Data sets for testing the EES API with a DfE dashboard
#>                      lastPublished
#> 1 2025-01-07T15:08:52.187975+00:00