Sample projects API

Golden 3.0.0 public API reference. Parameters, responses, and schemas for supported customer operations.

5 operations.

GET /api/samples

Lists the available sample projects.

Operation ID: listSamples

Returns every sample project this build ships, each saying whether it is currently installed. Requires the ADMIN role.

Security: bearerAuth

Responses

GET /api/samples/{id}

Retrieves a sample project.

Operation ID: getSample

Locates a sample project by identifier and returns it, including whether it is installed. Requires the ADMIN role.

Security: bearerAuth

Parameters

Responses

DELETE /api/samples/{id}

Removes a sample project.

Operation ID: removeSample

Removes everything the sample created: its records, resources, tables, entity, uploaded files, and the task schedulings it produced together with their runs. Nothing outside the sample’s own identifier prefixes is touched. Asynchronous - returns a task identifier to poll. Requires the ADMIN role.

Security: bearerAuth

Parameters

Responses

GET /api/samples/{id}/download

Downloads a sample project’s files.

Operation ID: downloadSample

Returns the sample as a zip archive: its manifest, every resource, table and entity bundle, its source data files exactly as the sources send them, and the outcomes its install is expected to produce. A sample’s pipelines change what it stores, so this is how the stored records are compared with the originals. Works whether or not the sample is installed. Requires the ADMIN role.

Security: bearerAuth

Parameters

Responses

POST /api/samples/{id}/install

Installs a sample project.

Operation ID: installSample

Removes any previous copy of the sample and installs it: uploads its data files, imports its resources, tables and entity, and runs a full load, index and classification. Asynchronous - returns a task identifier to poll. Installing is also how a sample is reinstalled, because installing over an existing copy cannot work. Requires the ADMIN role.

Security: bearerAuth

Parameters

Responses