ArtifactApi | @here/olp-sdk-ts

Namespace ArtifactApi

Type Aliases

OrderEnum

OrderEnum: "ASC" | "DESC"

PermissionsEnum

PermissionsEnum: "READ" | "MODIFY" | "SHARE"

TypeEnum

TypeEnum: "User" | "App" | "Group"

Functions

deleteArtifactUsingDELETE

deleteArtifactUsingDELETE(builder: RequestBuilder, params: { artifactHrn: string }): Promise<DeleteArtifactResponseObj>

- Defined in @here/olp-sdk-dataservice-api/lib/artifact-api.ts:154
Requires permission to 'modifyResource' for the given HRN

summary
Delete a specific artifact

Parameters
- builder: RequestBuilder
- params: { artifactHrn: string }
  - artifactHrn: string
Returns Promise<DeleteArtifactResponseObj>

deleteFileUsingDELETE

deleteFileUsingDELETE(builder: RequestBuilder, params: { artifactHrn: string; fileName: string }): Promise<DeleteFileResponseObj>

- Defined in @here/olp-sdk-dataservice-api/lib/artifact-api.ts:181
Requires permission to 'modifyResource' for the given HRN

summary
Delete a specific artifact file

Parameters
- builder: RequestBuilder
- params: { artifactHrn: string; fileName: string }
  - artifactHrn: string
  - fileName: string
Returns Promise<DeleteFileResponseObj>

deleteSchemaUsingDELETE

deleteSchemaUsingDELETE(builder: RequestBuilder, params: { schemaHrn: string }): Promise<DeleteSchemaResponseObj>

- Defined in @here/olp-sdk-dataservice-api/lib/artifact-api.ts:326
Requires permission to 'modifyResource' for the given HRN

summary
Delete schema

Parameters
- builder: RequestBuilder
- params: { schemaHrn: string }
  - schemaHrn: string
Returns Promise<DeleteSchemaResponseObj>

getArtifactFileUsingGET

getArtifactFileUsingGET(builder: RequestBuilder, params: { artifactHrn: string; fileName: string }): Promise<string>

- Defined in @here/olp-sdk-dataservice-api/lib/artifact-api.ts:207
Requires permission to 'readResource' for the given HRN

summary
Retrieve a specific artifact file

Parameters
- builder: RequestBuilder
- params: { artifactHrn: string; fileName: string }
  - artifactHrn: string
  - fileName: string
Returns Promise<string>

getArtifactUsingGET

getArtifactUsingGET(builder: RequestBuilder, params: { artifactHrn: string }): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/artifact-api.ts:230
summary
getArtifact

Parameters
- builder: RequestBuilder
- params: { artifactHrn: string }
  - artifactHrn: string
Returns Promise<Response>

getDocumentUsingGET

getDocumentUsingGET(builder: RequestBuilder, params: { file: string; schemaHrn: string }): Promise<string>

- Defined in @here/olp-sdk-dataservice-api/lib/artifact-api.ts:353
Requires permission to 'readResource' for the given HRN

summary
Resolve a schema doc variant URL

Parameters
- builder: RequestBuilder
- params: { file: string; schemaHrn: string }
  - file: string
  - schemaHrn: string
Returns Promise<string>

getSchemaUsingGET

getSchemaUsingGET(builder: RequestBuilder, params: { schemaHrn: string }): Promise<GetSchemaResponseObj>

- Defined in @here/olp-sdk-dataservice-api/lib/artifact-api.ts:378
Requires permission to 'readResource' for the given HRN

summary
Retrieve schema details

Parameters
- builder: RequestBuilder
- params: { schemaHrn: string }
  - schemaHrn: string
Returns Promise<GetSchemaResponseObj>

listUsingGET

listUsingGET(builder: RequestBuilder, params: { from?: string; limit?: number; order?: "ASC" | "DESC"; sort?: string }): Promise<ListSchemasResponseObj>

- Defined in @here/olp-sdk-dataservice-api/lib/artifact-api.ts:407
Requires permission to 'apiAccess'

summary
List the available schemas

Parameters
- builder: RequestBuilder
- params: { from?: string; limit?: number; order?: "ASC" | "DESC"; sort?: string }
  - Optional from?: string
  - Optional limit?: number
  - Optional order?: "ASC" | "DESC"
  - Optional sort?: string
Returns Promise<ListSchemasResponseObj>

putArtifactFileUsingPUT

putArtifactFileUsingPUT(builder: RequestBuilder, params: { artifactHrn: string; file: string; fileName: string }): Promise<Response>

- Defined in @here/olp-sdk-dataservice-api/lib/artifact-api.ts:258
Requires permission to 'modifyResource' for the given HRN

summary
Create or update a specific artifact

Parameters
- builder: RequestBuilder
- params: { artifactHrn: string; file: string; fileName: string }
  - artifactHrn: string
  - file: string
  - fileName: string
Returns Promise<Response>

registerArtifactUsingPUT

registerArtifactUsingPUT(builder: RequestBuilder, params: { artifactId: string; groupId: string; registerRequest?: RegisterArtifactRequest }): Promise<RegisterArtifactResponse>

- Defined in @here/olp-sdk-dataservice-api/lib/artifact-api.ts:289
Requires permission to 'apiAccess'

summary
Register a new group and artifact

Parameters
- builder: RequestBuilder
- params: { artifactId: string; groupId: string; registerRequest?: RegisterArtifactRequest }
  - artifactId: string
  - groupId: string
  - Optional registerRequest?: RegisterArtifactRequest
Returns Promise<RegisterArtifactResponse>

updateSchemaPermissionUsingPOST

updateSchemaPermissionUsingPOST(builder: RequestBuilder, params: { schemaHrn: string; updatePermissionRequest?: UpdatePermissionRequest }): Promise<UpdatePermissionResponse>

- Defined in @here/olp-sdk-dataservice-api/lib/artifact-api.ts:441
READ grants 'readResource', MODIFY grants 'modifyResource', SHARE grants 'shareResource'. Requires permission to 'shareResource' for the given HRN.

summary
Update schema permissions for user on the specified schema and associated artifact.

Parameters
- builder: RequestBuilder
- params: { schemaHrn: string; updatePermissionRequest?: UpdatePermissionRequest }
  - schemaHrn: string
  - Optional updatePermissionRequest?: UpdatePermissionRequest
Returns Promise<UpdatePermissionResponse>

Generated using TypeDoc

Index

Interfaces

Type Aliases

Functions

Type Aliases

OrderEnum

PermissionsEnum

TypeEnum

Functions

deleteArtifactUsingDELETE

Parameters

builder: RequestBuilder

params: { artifactHrn: string }

artifactHrn: string

Returns Promise<DeleteArtifactResponseObj>

deleteFileUsingDELETE

Parameters

builder: RequestBuilder

params: { artifactHrn: string; fileName: string }

artifactHrn: string

fileName: string

Returns Promise<DeleteFileResponseObj>

deleteSchemaUsingDELETE

Parameters

builder: RequestBuilder

params: { schemaHrn: string }

schemaHrn: string

Returns Promise<DeleteSchemaResponseObj>

getArtifactFileUsingGET

Parameters

builder: RequestBuilder

params: { artifactHrn: string; fileName: string }

artifactHrn: string

fileName: string

Returns Promise<string>

getArtifactUsingGET

Parameters

builder: RequestBuilder

params: { artifactHrn: string }

artifactHrn: string

Returns Promise<Response>

getDocumentUsingGET

Parameters

builder: RequestBuilder

params: { file: string; schemaHrn: string }

file: string

schemaHrn: string

Returns Promise<string>

getSchemaUsingGET

Parameters

builder: RequestBuilder

params: { schemaHrn: string }

schemaHrn: string

Returns Promise<GetSchemaResponseObj>

listUsingGET

Parameters

builder: RequestBuilder

params: { from?: string; limit?: number; order?: "ASC" | "DESC"; sort?: string }

Optional from?: string

Optional limit?: number

Optional order?: "ASC" | "DESC"

Optional sort?: string

Returns Promise<ListSchemasResponseObj>

putArtifactFileUsingPUT

Parameters

builder: RequestBuilder

params: { artifactHrn: string; file: string; fileName: string }

artifactHrn: string

file: string

fileName: string

Returns Promise<Response>

registerArtifactUsingPUT

Parameters

builder: RequestBuilder

params: { artifactId: string; groupId: string; registerRequest?: RegisterArtifactRequest }

artifactId: string

groupId: string

Optional registerRequest?: RegisterArtifactRequest

Returns Promise<RegisterArtifactResponse>

updateSchemaPermissionUsingPOST