Class ProjectService

Hierarchy

BaseService
- ProjectService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ProjectService(options: IRocosClientOptions): ProjectService

Inherited from BaseService.constructor
- Defined in src/services/base-service.ts:9
Parameters
- options: IRocosClientOptions
Returns ProjectService

Properties

Protected httpRequest

httpRequest: HttpRequest

Protected options

options: IRocosClientOptions

Methods

create

create(proj: Project): Observable<RocosResponse<any>>

- Defined in src/services/project-service.ts:25
Create a new project.

Parameters
- proj: Project
  
  Project object
Returns Observable<RocosResponse<any>>

createOperation

createOperation(projectId: string, op: Operation): Observable<RocosResponse<any>>

- Defined in src/services/project-service.ts:156
Create a new project.

Parameters
- projectId: string
- op: Operation
Returns Observable<RocosResponse<any>>

createProjectByTemplate

createProjectByTemplate(templateId: string, body?: any): Observable<RocosResponse<any>>

- Defined in src/services/project-service.ts:138
Create project by template.

Parameters
- templateId: string
  
  Template ID - From back-end responses
- Optional body: any
  
  Optional parameters
Returns Observable<RocosResponse<any>>

createProjectUnderAccount

createProjectUnderAccount(accountId: string, proj: Project): Observable<RocosResponse<any>>

- Defined in src/services/project-service.ts:119
Create a project under a specified account

Parameters
- accountId: string
- proj: Project
  
  Project
Returns Observable<RocosResponse<any>>

delete

delete(accountId: string, projectId: string): Observable<RocosResponse<any>>

- Defined in src/services/project-service.ts:93
Delete project by account id and project id.

Parameters
- accountId: string
  
  Account Id
- projectId: string
  
  Project Id
Returns Observable<RocosResponse<any>>

deleteOperationsForProject

deleteOperationsForProject(projectId: string, operationIds: string[]): Observable<RocosResponse<any>>

- Defined in src/services/project-service.ts:197
Delete operations for project

Parameters
- projectId: string
  
  Project Id
- operationIds: string[]
  
  Operation Ids
Returns Observable<RocosResponse<any>>

getOperation

getOperation(projectId: string, operationId: string): Observable<RocosResponse<any>>

- Defined in src/services/project-service.ts:183
Get operation by project Id and operation Id.

Parameters
- projectId: string
  
  Project Id
- operationId: string
  
  Operation Id
Returns Observable<RocosResponse<any>>

getOperationsList

getOperationsList(projectId: string): Observable<RocosResponse<any>>

- Defined in src/services/project-service.ts:170
Get operations list by project id

Parameters
- projectId: string
  
  Project Id
Returns Observable<RocosResponse<any>>

info

info(projectId: string): Observable<RocosResponse<Project>>

- Defined in src/services/project-service.ts:80
Get project information by project id.

Parameters
- projectId: string
  
  Project Id
Returns Observable<RocosResponse<Project>>

list

list(): Observable<RocosResponse<any>>

- Defined in src/services/project-service.ts:41
Get projects list by current account info

Returns Observable<RocosResponse<any>>

listExternalProjects

listExternalProjects(accountId: string): Observable<RocosResponse<ExternalProject[]>>

- Defined in src/services/project-service.ts:50
Get projects list by current account info

Parameters
- accountId: string
Returns Observable<RocosResponse<ExternalProject[]>>

projectsUnderAccount

projectsUnderAccount(accountId: string): Observable<RocosResponse<Project[]>>

- Defined in src/services/project-service.ts:107
Get projects under account by using the account id.

Parameters
- accountId: string
  
  Account Id
Returns Observable<RocosResponse<Project[]>>

update

update(projectId: string, proj: Project): Observable<RocosResponse<any>>

- Defined in src/services/project-service.ts:61
Update project information.

Parameters
- projectId: string
  
  Project Id
- proj: Project
  
  Project object
Returns Observable<RocosResponse<any>>

updateOperation

updateOperation(projectId: string, operationId: string, op: Operation): Observable<RocosResponse<any>>

- Defined in src/services/project-service.ts:213
Update operation

Parameters
- projectId: string
  
  Proejct Id
- operationId: string
  
  Operation Id
- op: Operation
  
  Content
Returns Observable<RocosResponse<any>>

Generated using TypeDoc