Interface Services

Runtime + business-service surface (the services namespace).

interface Services {
    getServiceInfo(
        ref: ObjectRef,
        opts?: { service?: string },
    ): Promise<ServiceInfo>;
    listServices(ref: ObjectRef): Promise<ServiceBindingServices>;
    publishServiceBinding(ref: ObjectRef): Promise<unknown>;
    runApplication(ref: ObjectRef): Promise<{ output: string }>;
    serviceBindingDetails(ref: ObjectRef): Promise<unknown>;
}

Index

Methods

getServiceInfo listServices publishServiceBinding runApplication serviceBindingDetails

Methods

getServiceInfo

getServiceInfo(
ref: ObjectRef,
opts?: { service?: string },
): Promise<ServiceInfo>
Live OData service info — the service URL + entity sets — for a binding's service (chains fetch_services → fetch_service_information). For an unpublished V4 binding this throws asking you to publish first. service picks a specific service (default: first).
Parameters
- ref: ObjectRef
- Optionalopts: { service?: string }
Returns Promise<ServiceInfo>
- Defined in api/services.ts:59

listServices

listServices(ref: ObjectRef): Promise<ServiceBindingServices>
List the OData services a binding exposes (type, version, definitions, publish state).
Parameters
- ref: ObjectRef
Returns Promise<ServiceBindingServices>
- Defined in api/services.ts:55

publishServiceBinding

publishServiceBinding(ref: ObjectRef): Promise<unknown>
Publish (or unpublish) a service binding — mutating.
Parameters
- ref: ObjectRef
Returns Promise<unknown>
- Defined in api/services.ts:53

runApplication

runApplication(ref: ObjectRef): Promise<{ output: string }>
Run an executable object (classrun / program) and return its console output.
Parameters
- ref: ObjectRef
Returns Promise<{ output: string }>
- Defined in api/services.ts:49

serviceBindingDetails

serviceBindingDetails(ref: ObjectRef): Promise<unknown>
Read a service binding's details (binding type, OData version, service list).
Parameters
- ref: ObjectRef
Returns Promise<unknown>
- Defined in api/services.ts:51