CX-02

UpKeep

Interface operations, auth, source semantics, version/edition support, shared driver relationships, documentation, gaps and ownership.

Acceptance · Show technical reference grade separately from implementation and environment qualification. Operations getConnectorManifest

CS-CON-0144UpKeepF12 · MES maintenance and product lifecycleT06DETAILstatus: proposed_targetqualification: not_run

CX-02 Profile CX-03 Configure connection CX-08 Source contract CX-11 Laboratory CX-12 Evidence CX-14 Qualification

Synthetic connector workspace. Every profile here is a proposed target. Nothing on this screen is a live, qualified or certified adapter, no payload is a captured vendor wire message, and the simulation engine has no code path to a real endpoint.

Profile

Source surface

/api/v2 work orders/assets/locations/users read resources

Engine

rest

Authentication

Authenticated session/API token from protected credential flow

Incremental and recovery

Page/limit and resource timestamps; preserve archived and deleted status when exposed

Constraints

API token renewal and plan limits tested; comments/attachments require permissions and independent evidence references.

Implementation kind

provider_or_product_profile

Runtime placement options

plant, private_cloud, cloud

Documentation

https://developers.onupkeep.com/

What is known, and how well

Source-evidence grade — DETAIL

Technical reference reviewed

Reviewer note

Primary technical documentation reviewed for the stated interface. The CoreSync build profile is still proposed; operation-level schemas, exact edition and runtime tests must be pinned.

Vendor wire schema

not_embedded; pin licensed/OpenAPI/WSDL/device spec at qualification

Native sample

synthetic post-decoder fixture only; not a captured vendor wire payload

Runtime implementation

unassessed_existing_or_not_built

Qualification

not_run

Selection basis

Industrial relevance and broad source-system coverage; not a measured popularity ranking (reference 2026-09-22)

Evidence grade describes the public technical reference material only. It is not implementation status and not qualification in any environment.

Live-activation gates — 0 of 5 satisfied

live activation blocked

Live-activation gate	State	Basis
Authorized access proven at the source	not satisfied	No connection configured.
Source edition / version pinned	not satisfied	Edition not pinned.
Approved native source schema	not satisfied	Vendor wire schema status: not_embedded; pin licensed/OpenAPI/WSDL/device spec at qualification.
Signed runtime package	not satisfied	Runtime implementation: unassessed_existing_or_not_built.
Qualification evidence in this environment	not satisfied	Qualification: not_run.

Block until exact provider version, native schema, authorization, adapter package and environment qualification evidence are present.

Shared template T06 · Enterprise API and OData

Canonical entity

EntityChangeObserved

Wire shape

json

Resources

orders, materials, business_partners

Natural keys

recordId, revision

Time field

updatedAt

Modelled failures

rate_limit, partial_success, auth_expired, schema_drift

Template field shape

{
  "recordId": "string",
  "revision": "string",
  "updatedAt": "date-time",
  "status": "string",
  "fields": "object"
}

Configuration, packaging and acceptance

Configuration schema

catalogue/config-schemas/CS-CON-0144.schema.json

Source contract

contracts/source-contracts/CS-CON-0144.json

Package requirements

Version-pinned adapter and transitive dependencies; SBOM and third-party redistribution/license review; Configuration + native source schemas; Connection/discovery/read/recovery tests; Locality and secret-binding enforcement; Reference mapping templates with approval gates; Operating limits and upgrade/rollback guide

Specific configuration

api_base_url
locations
resource_types
page_size
update_window

Acceptance tests

CS-CON-0144-AT-01	Connect and discover only authorized resources; reject unauthorized identity	not_run
CS-CON-0144-AT-02	Read declared source surface and preserve original key/time/quality	not_run
CS-CON-0144-AT-03	Resume according to profile cursor; retention loss explicitly reported	not_run
CS-CON-0144-AT-04	Duplicate/revision and partial-result behavior matches declared contract	not_run
CS-CON-0144-AT-05	Contract drift quarantined; no secret leakage or source control side effects	not_run
CS-CON-0144-AT-06	Qualify against exact source constraints: API token renewal and plan limits tested; comments/attachments require permissions and independent evidence references.	not_run

Canonical output and use-case reference

Canonical output candidates

EntityChangeObserved

Canonical contract policy

Candidate envelope family only. Approve source-specific bindings through the canonical authority; no business vocabulary in the driver.

Referenced use-case families

ENT, PER, SRC, MAP, DQ, REC, SEC, CFG, VAL

Exact use-case mapping

unassessed — family-level reference only. It does not claim any of the 192 use cases as covered. Open CX-16 coverage

Simulation scenarios declared for this profile

Happy pathAuthentication expiredNative schema driftDuplicate deliveryRate limit / quotaPartial success

Run these in the CX-11 laboratory →

Connections configured against this profile

None yet. Configure a simulated connection (CX-03).

Other profiles in F12

CS-CON-0135SAP Digital Manufacturing CS-CON-0136Siemens Opcenter Execution CS-CON-0137GE Proficy Plant Applications CS-CON-0138Tulip CS-CON-0139Sepasoft MES CS-CON-0140AVEVA MES CS-CON-0141IBM Maximo Manage CS-CON-0142Fiix CS-CON-0143MaintainX CS-CON-0145Limble CMMS CS-CON-0146PTC Windchill CS-CON-0147Siemens Teamcenter CS-CON-0148Autodesk Fusion Manage CS-CON-0149Aras Innovator CS-CON-0150Arena PLM