organization_software
This section covers the Software model and the SoftwareFinder class used to create, configure and query hardware software resources associated with an organization.
Subsections of organization_software
Software Finder
This class allows making GET requests to the hardware software resource in the OpenGate North API.
constructor
Constructor
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ogapi | InternalOpenGateAPI |
❌ | Reference to the API object. |
administrable()
Marks visibility administrable for software list retrieval
Retorna
Tip
Tipo: this
assignable()
Marks visibility assignable for software list retrieval
Retorna
Tip
Tipo: this
findByOrganization(organization)
Retrieves all software from a organization
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| organization | string |
❌ | organization name . |
Retorna
Tip
Tipo: Promise
findByOrganizationAndId(organization, identifier)
Retrieves a specific software
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| organization | string |
❌ | organization name . |
| identifier | string |
❌ | software name . |
Retorna
Tip
Tipo: Promise
Softwares
This is a base object that contains everything you can do with Softwares.
constructor
Constructor
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ogapi | InternalOpenGateAPI |
❌ | Reference to the API object. |
withIdentifier(id)
Set the identifier attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| id | string |
❌ | required field |
Retorna
Tip
Tipo: Softwares
withModels(models)
Set the model attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| models | Array |
❌ |
Retorna
Tip
Tipo: Softwares
withName(name)
Set the name attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| name | string |
❌ | required field |
Retorna
Tip
Tipo: Softwares
withType(type)
Set the type attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| type | string |
❌ |
Retorna
Tip
Tipo: Softwares
withVersion(version)
Set the version attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| version | string |
❌ | required field |
Retorna
Tip
Tipo: Softwares