Context | Orishare docs

Read environment context and project presentation. ETag targets context.version; Presentation-ETag targets presentation_revision.

Authorization

AuthorizationBearer <token>

Audited staff access with a staff grant and audit reason.

In: header

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length

X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/context"

{  "business_type": "game",  "terminology": {    "property1": {      "singular": "string",      "plural": "string",      "locales": {        "property1": {          "singular": "string",          "plural": "string"        },        "property2": {          "singular": "string",          "plural": "string"        }      }    },    "property2": {      "singular": "string",      "plural": "string",      "locales": {        "property1": {          "singular": "string",          "plural": "string"        },        "property2": {          "singular": "string",          "plural": "string"        }      }    }  },  "mechanics": {    "property1": "enabled",    "property2": "enabled"  },  "default_locale": "string",  "presentation_revision": 0,  "environment_id": "string",  "business_description": "string",  "vocabulary": {    "property1": null,    "property2": null  },  "glossary": {    "property1": null,    "property2": null  },  "version": 0,  "updated_at": "2019-08-24T14:15:22Z"}

Patch legacy environment context with optional If-Match against version, or project presentation with required If-Match against presentation_revision. Mixed targets are rejected; presentation responses use that revision as ETag. Null removes an override. Updates and audit commit atomically. There is no HTTP response cache: repeating the committed If-Match yields stale_write.

Authorization

AuthorizationBearer <token>

Audited staff access with a staff grant and audit reason.

In: header

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length

X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

If-Match?string

Optional legacy revision. Missing or malformed values follow the existing route parser.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

business_description?|null

vocabulary?

glossary?

business_type?string

Value in

"game"
"consumer_app"
"store"
"enterprise"
"custom"

terminology?

mechanics?

default_locale?string

Match^[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*$

Lengthlength <= 35

Response Body

`application/json`

curl -X PATCH "https://example.com/context" \  -H "Content-Type: application/json" \  -d '{    "default_locale": "fr"  }'

{  "business_type": "game",  "terminology": {    "property1": {      "singular": "string",      "plural": "string",      "locales": {        "property1": {          "singular": "string",          "plural": "string"        },        "property2": {          "singular": "string",          "plural": "string"        }      }    },    "property2": {      "singular": "string",      "plural": "string",      "locales": {        "property1": {          "singular": "string",          "plural": "string"        },        "property2": {          "singular": "string",          "plural": "string"        }      }    }  },  "mechanics": {    "property1": "enabled",    "property2": "enabled"  },  "default_locale": "string",  "presentation_revision": 0,  "environment_id": "string",  "business_description": "string",  "vocabulary": {    "property1": null,    "property2": null  },  "glossary": {    "property1": null,    "property2": null  },  "version": 0,  "updated_at": "2019-08-24T14:15:22Z"}

List the business types with the terminology and mechanic modes each one starts from. Static: the same for every caller, no ETag.

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/context/presets"

{  "data": [    {      "business_type": "game",      "terminology": {        "property1": {          "singular": "string",          "plural": "string"        },        "property2": {          "singular": "string",          "plural": "string"        }      },      "mechanics": {        "property1": "enabled",        "property2": "enabled"      }    }  ]}

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

421application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`