Class EpSdkSchemaVersionsServiceClass

Hierarchy

EpSdkVersionServiceClass
- EpSdkSchemaVersionsServiceClass

Index

Constructors

Methods

copyLastestVersionById_IfNotExists createSchemaVersion getEpObjectVersionFromList getLatestEpObjectVersionFromList getLatestVersionForSchemaId getLatestVersionForSchemaName getLatestVersionString getVersionByVersion getVersionsForSchemaId getVersionsForSchemaName setCustomAttributes sortEpObjectVersionListByVersion updateSchemaVersion

Constructors

constructor

new EpSdkSchemaVersionsServiceClass(): EpSdkSchemaVersionsServiceClass
Returns EpSdkSchemaVersionsServiceClass

Inherited from EpSdkVersionServiceClass.constructor

Methods

copyLastestVersionById_IfNotExists

copyLastestVersionById_IfNotExists(__namedParameters: {
    schemaVersionId: string;
    toApplicationDomainId: string;
    xContextId?: string;
}): Promise<SchemaVersion>
Parameters
- __namedParameters: {
      schemaVersionId: string;
      toApplicationDomainId: string;
      xContextId?: string;
  }
  - schemaVersionId: string
  - toApplicationDomainId: string
  - Optional xContextId?: string
Returns Promise<SchemaVersion>
- Defined in packages/ep-sdk/src/services/EpSdkSchemaVersionsService.ts:363

createSchemaVersion

createSchemaVersion(__namedParameters: {
    applicationDomainId: string;
    schemaId: string;
    schemaVersion: SchemaVersion;
    targetLifecycleStateId: string;
    xContextId?: string;
}): Promise<SchemaVersion>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      schemaId: string;
      schemaVersion: SchemaVersion;
      targetLifecycleStateId: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - schemaId: string
  - schemaVersion: SchemaVersion
  - targetLifecycleStateId: string
  - Optional xContextId?: string
Returns Promise<SchemaVersion>
- Defined in packages/ep-sdk/src/services/EpSdkSchemaVersionsService.ts:266

`Protected` getEpObjectVersionFromList

getEpObjectVersionFromList(__namedParameters: {
epObjectVersionList: any[];
versionString: string;
}): any
Parameters
- __namedParameters: {
  epObjectVersionList: any[];
  versionString: string;
  }
  - epObjectVersionList: any[]
  - versionString: string
Returns any
Inherited from EpSdkVersionServiceClass.getEpObjectVersionFromList
- Defined in packages/ep-sdk/src/services/EpSdkVersionService.ts:44

getLatestEpObjectVersionFromList

getLatestEpObjectVersionFromList(__namedParameters: {
epObjectVersionList: any[];
}): any
Parameters
- __namedParameters: {
  epObjectVersionList: any[];
  }
  - epObjectVersionList: any[]
Returns any
Inherited from EpSdkVersionServiceClass.getLatestEpObjectVersionFromList
- Defined in packages/ep-sdk/src/services/EpSdkVersionService.ts:10

getLatestVersionForSchemaId

getLatestVersionForSchemaId(__namedParameters: {
    applicationDomainId: string;
    schemaId: string;
    xContextId?: string;
}): Promise<SchemaVersion>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      schemaId: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - schemaId: string
  - Optional xContextId?: string
Returns Promise<SchemaVersion>
- Defined in packages/ep-sdk/src/services/EpSdkSchemaVersionsService.ts:224

getLatestVersionForSchemaName

getLatestVersionForSchemaName(__namedParameters: {
    applicationDomainId: string;
    schemaName: string;
    xContextId?: string;
}): Promise<SchemaVersion>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      schemaName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - schemaName: string
  - Optional xContextId?: string
Returns Promise<SchemaVersion>
- Defined in packages/ep-sdk/src/services/EpSdkSchemaVersionsService.ts:245

getLatestVersionString

getLatestVersionString(__namedParameters: {
schemaId: string;
xContextId?: string;
}): Promise<string>
Parameters
- __namedParameters: {
  schemaId: string;
  xContextId?: string;
  }
  - schemaId: string
  - Optional xContextId?: string
Returns Promise<string>
- Defined in packages/ep-sdk/src/services/EpSdkSchemaVersionsService.ts:192

getVersionByVersion

getVersionByVersion(__namedParameters: {
    schemaId: string;
    schemaVersionString: string;
    xContextId?: string;
}): Promise<SchemaVersion>
Parameters
- __namedParameters: {
      schemaId: string;
      schemaVersionString: string;
      xContextId?: string;
  }
  - schemaId: string
  - schemaVersionString: string
  - Optional xContextId?: string
Returns Promise<SchemaVersion>
- Defined in packages/ep-sdk/src/services/EpSdkSchemaVersionsService.ts:92

getVersionsForSchemaId

getVersionsForSchemaId(__namedParameters: {
    pageSize?: number;
    schemaId: string;
    xContextId?: string;
}): Promise<SchemaVersion[]>
Parameters
- __namedParameters: {
      pageSize?: number;
      schemaId: string;
      xContextId?: string;
  }
  - Optional pageSize?: number
  - schemaId: string
  - Optional xContextId?: string
Returns Promise<SchemaVersion[]>
- Defined in packages/ep-sdk/src/services/EpSdkSchemaVersionsService.ts:113

getVersionsForSchemaName

getVersionsForSchemaName(__namedParameters: {
    applicationDomainId: string;
    schemaName: string;
    xContextId?: string;
}): Promise<SchemaVersion[]>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      schemaName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - schemaName: string
  - Optional xContextId?: string
Returns Promise<SchemaVersion[]>
- Defined in packages/ep-sdk/src/services/EpSdkSchemaVersionsService.ts:170

setCustomAttributes

setCustomAttributes(__namedParameters: {
    epSdkCustomAttributes: TEpSdkCustomAttribute[];
    schemaVersionId: string;
    xContextId?: string;
}): Promise<SchemaVersion>
Sets the custom attributes in the list on the Schema Version object. Creates attribute definitions / adds entity type 'schemaVersion' if it doesn't exist.
Parameters
- __namedParameters: {
      epSdkCustomAttributes: TEpSdkCustomAttribute[];
      schemaVersionId: string;
      xContextId?: string;
  }
  - epSdkCustomAttributes: TEpSdkCustomAttribute[]
  - schemaVersionId: string
  - Optional xContextId?: string
Returns Promise<SchemaVersion>
- Defined in packages/ep-sdk/src/services/EpSdkSchemaVersionsService.ts:64

sortEpObjectVersionListByVersion

sortEpObjectVersionListByVersion(__namedParameters: {
epObjectVersionList: any[];
}): any
Returns sorted list by version in semVer format. Sorts descending, i.e. latest version is the first element in the returned list.
Parameters
- __namedParameters: {
  epObjectVersionList: any[];
  }
  - epObjectVersionList: any[]
Returns any
Inherited from EpSdkVersionServiceClass.sortEpObjectVersionListByVersion
- Defined in packages/ep-sdk/src/services/EpSdkVersionService.ts:24

`Private` updateSchemaVersion

updateSchemaVersion(__namedParameters: {
update: SchemaVersion;
xContextId?: string;
}): Promise<SchemaVersion>
Parameters
- __namedParameters: {
  update: SchemaVersion;
  xContextId?: string;
  }
  - update: SchemaVersion
  - Optional xContextId?: string
Returns Promise<SchemaVersion>
- Defined in packages/ep-sdk/src/services/EpSdkSchemaVersionsService.ts:42

Class EpSdkSchemaVersionsServiceClass

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EpSdkSchemaVersionsServiceClass

Methods

copyLastestVersionById_IfNotExists

Parameters

__namedParameters: { schemaVersionId: string; toApplicationDomainId: string; xContextId?: string; }

schemaVersionId: string

toApplicationDomainId: string

Optional xContextId?: string

Returns Promise<SchemaVersion>

createSchemaVersion

Parameters

__namedParameters: { applicationDomainId: string; schemaId: string; schemaVersion: SchemaVersion; targetLifecycleStateId: string; xContextId?: string; }

applicationDomainId: string

schemaId: string

schemaVersion: SchemaVersion

targetLifecycleStateId: string

Optional xContextId?: string

Returns Promise<SchemaVersion>

Protected getEpObjectVersionFromList

Parameters

__namedParameters: { epObjectVersionList: any[]; versionString: string; }

epObjectVersionList: any[]

versionString: string

Returns any

getLatestEpObjectVersionFromList

Parameters

__namedParameters: { epObjectVersionList: any[]; }

epObjectVersionList: any[]

Returns any

getLatestVersionForSchemaId

Parameters

__namedParameters: { applicationDomainId: string; schemaId: string; xContextId?: string; }

applicationDomainId: string

schemaId: string

Optional xContextId?: string

Returns Promise<SchemaVersion>

getLatestVersionForSchemaName

Parameters

__namedParameters: { applicationDomainId: string; schemaName: string; xContextId?: string; }

applicationDomainId: string

schemaName: string

Optional xContextId?: string

Returns Promise<SchemaVersion>

getLatestVersionString

Parameters

__namedParameters: { schemaId: string; xContextId?: string; }

schemaId: string

Optional xContextId?: string

Returns Promise<string>

getVersionByVersion

Parameters

__namedParameters: { schemaId: string; schemaVersionString: string; xContextId?: string; }

schemaId: string

schemaVersionString: string

Optional xContextId?: string

Returns Promise<SchemaVersion>

getVersionsForSchemaId

Parameters

__namedParameters: { pageSize?: number; schemaId: string; xContextId?: string; }

Optional pageSize?: number

schemaId: string

Optional xContextId?: string

Returns Promise<SchemaVersion[]>

getVersionsForSchemaName

Parameters

__namedParameters: { applicationDomainId: string; schemaName: string; xContextId?: string; }

applicationDomainId: string

schemaName: string

Optional xContextId?: string

Returns Promise<SchemaVersion[]>

setCustomAttributes

Parameters

__namedParameters: { epSdkCustomAttributes: TEpSdkCustomAttribute[]; schemaVersionId: string; xContextId?: string; }

__namedParameters: {
schemaVersionId: string;
toApplicationDomainId: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
applicationDomainId: string;
schemaId: string;
schemaVersion: SchemaVersion;
targetLifecycleStateId: string;
xContextId?: string;
}

`Optional` xContextId?: string

`Protected` getEpObjectVersionFromList

__namedParameters: {
epObjectVersionList: any[];
versionString: string;
}

__namedParameters: {
epObjectVersionList: any[];
}

__namedParameters: {
applicationDomainId: string;
schemaId: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
applicationDomainId: string;
schemaName: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
schemaId: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
schemaId: string;
schemaVersionString: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
pageSize?: number;
schemaId: string;
xContextId?: string;
}

`Optional` pageSize?: number

`Optional` xContextId?: string

__namedParameters: {
applicationDomainId: string;
schemaName: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
epSdkCustomAttributes: TEpSdkCustomAttribute[];
schemaVersionId: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
epObjectVersionList: any[];
}

`Private` updateSchemaVersion

__namedParameters: {
update: SchemaVersion;
xContextId?: string;
}

`Optional` xContextId?: string