Stryke REST API (0.12.2)

Download OpenAPI specification:Download

This documentation describes all APIs and endpoints available to interact with Stryke.

APIs are available to interact with the Stryke platform itself as well as interacting with App Instances, their data and users. To focus on either the Stryke APIs or the App Instance APIs select the corresponding spec in the Swagger UI.

All endpoints expect an authentication token, which is generated when calling the login endpoint (either for a Stryke user or App Instance user, with their respective logins). The authentication token returned by the login endpoints is to be provided as a header ("Authorization" header) in all calls in the following form: "Bearer [token value]".

Authentication

basicAuth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

bearerToken

Security Scheme Type API Key
Header parameter name: Authorization

Access Control

Entity Metadata Access Control Controller

List records

Returns a list of all the records

Authorizations:
path Parameters
apiVersion
required
string
Example: v1

A path parameter used to specify the API version to use

appInstanceName
required
string
Example: myapp

Name of the App Instance where to perform the operation

query Parameters
whatId
required
string <uuid>
Example: whatId=4ae76fb8-9152-4fd7-8cc3-4aeaf2f23912

A query parameter used to filter the results of this request to only return resource access records related to a specific resource (by its ID).

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get /{apiVersion}/{appInstanceName}/access
https://api.stryke.io/{apiVersion}/{appInstanceName}/access

Response samples

Content type
application/json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "data": { },
  • "message": "string",
  • "returnCode": 0
}

Upserts the resource access record

Upserts a resource access record. The upsert will be performed based on the unique combination of the what ID and who ID. If a record with that what ID and who ID combination already exists it will be updated, otherwise it will be created.

Authorizations:
path Parameters
apiVersion
required
string
Example: v1

A path parameter used to specify the API version to use

appInstanceName
required
string
Example: myapp

Name of the App Instance where to perform the operation

Request Body schema: application/json

The data with which this record will be upserted

created
string <date-time>
how
string
Enum: "viewAllEditAll" "viewAllEditMine" "viewAllEditNone" "viewMineEditMine" "none"
id
string <uuid>
lastModified
string <date-time>
type
string
Value: "roleMetadata"
whatId
string <uuid>
whoId
string <uuid>

Responses

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post /{apiVersion}/{appInstanceName}/access
https://api.stryke.io/{apiVersion}/{appInstanceName}/access

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "created": "2020-01-23T17:54:00Z",
  • "how": "viewAllEditAll",
  • "id": "string",
  • "lastModified": "2020-01-23T17:54:00Z",
  • "type": "roleMetadata",
  • "whatId": "string",
  • "whoId": "string"
}

Response samples

Content type
application/json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "data": { },
  • "message": "string",
  • "returnCode": 0
}

Upserts the resource access record

Upserts a resource access record. The upsert will be performed based on the unique combination of the what ID and who ID. If a record with that what ID and who ID combination already exists it will be updated, otherwise it will be created.

Authorizations:
path Parameters
apiVersion
required
string
Example: v1

A path parameter used to specify the API version to use

appInstanceName
required
string
Example: myapp

Name of the App Instance where to perform the operation

Request Body schema: application/json

The data with which this record will be upserted

created
string <date-time>
how
string
Enum: "viewAllEditAll" "viewAllEditMine" "viewAllEditNone" "viewMineEditMine" "none"
id
string <uuid>
lastModified
string <date-time>
type
string
Value: "roleMetadata"
whatId
string <uuid>
whoId
string <uuid>

Responses

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

put /{apiVersion}/{appInstanceName}/access
https://api.stryke.io/{apiVersion}/{appInstanceName}/access

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "created": "2020-01-23T17:54:00Z",
  • "how": "viewAllEditAll",
  • "id": "string",
  • "lastModified": "2020-01-23T17:54:00Z",
  • "type": "roleMetadata",
  • "whatId": "string",
  • "whoId": "string"
}

Response samples

Content type
application/json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "data": { },
  • "message": "string",
  • "returnCode": 0
}

Find metadata by name

Retrieves an Entity Metadata record by name

Authorizations:
path Parameters
apiVersion
required
string
Example: v1

A path parameter used to specify the API version to use

appInstanceName
required
string
Example: myAppInstance

A path parameter used to specify the name of the app instance that this request is targeting

recordId
required
string <uuid>

A path parameter used to specify the ID of the entity metadata record to update

Request Body schema: application/json

Access control data with which to update the existing metadata record

array
boolean
bigDecimal
boolean
bigInteger
boolean
binary
boolean
boolean
boolean
containerNode
boolean
double
boolean
float
boolean
floatingPointNumber
boolean
int
boolean
integralNumber
boolean
long
boolean
missingNode
boolean
nodeType
string
Enum: "ARRAY" "BINARY" "BOOLEAN" "MISSING" "NULL" "NUMBER" "OBJECT" "POJO" "STRING"
null
boolean
number
boolean
object
boolean
pojo
boolean
short
boolean
textual
boolean
valueNode
boolean

Responses

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post /{apiVersion}/{appInstanceName}/access/updateentity/{recordId}
https://api.stryke.io/{apiVersion}/{appInstanceName}/access/updateentity/{recordId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "array": true,
  • "bigDecimal": true,
  • "bigInteger": true,
  • "binary": true,
  • "boolean": true,
  • "containerNode": true,
  • "double": true,
  • "float": true,
  • "floatingPointNumber": true,
  • "int": true,
  • "integralNumber": true,
  • "long": true,
  • "missingNode": true,
  • "nodeType": "ARRAY",
  • "null": true,
  • "number": true,
  • "object": true,
  • "pojo": true,
  • "short": true,
  • "textual": true,
  • "valueNode": true
}

Response samples

Content type
application/json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "data": { },
  • "message": "string",
  • "returnCode": 0
}

Find metadata by name

Retrieves an Entity Metadata record by name

Authorizations:
path Parameters
apiVersion
required
string
Example: v1

A path parameter used to specify the API version to use

appInstanceName
required
string
Example: myAppInstance

A path parameter used to specify the name of the app instance that this request is targeting

recordId
required
string <uuid>

A path parameter used to specify the ID of the entity metadata record to update

Request Body schema: application/json

Access control data with which to update the existing metadata record

array
boolean
bigDecimal
boolean
bigInteger
boolean
binary
boolean
boolean
boolean
containerNode
boolean
double
boolean
float
boolean
floatingPointNumber
boolean
int
boolean
integralNumber
boolean
long
boolean
missingNode
boolean
nodeType
string
Enum: "ARRAY" "BINARY" "BOOLEAN" "MISSING" "NULL" "NUMBER" "OBJECT" "POJO" "STRING"
null
boolean
number
boolean
object
boolean
pojo
boolean
short
boolean
textual
boolean
valueNode
boolean

Responses

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

put /{apiVersion}/{appInstanceName}/access/updateentity/{recordId}
https://api.stryke.io/{apiVersion}/{appInstanceName}/access/updateentity/{recordId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "array": true,
  • "bigDecimal": true,
  • "bigInteger": true,
  • "binary": true,
  • "boolean": true,
  • "containerNode": true,
  • "double": true,
  • "float": true,
  • "floatingPointNumber": true,
  • "int": true,
  • "integralNumber": true,
  • "long": true,
  • "missingNode": true,
  • "nodeType": "ARRAY",
  • "null": true,
  • "number": true,
  • "object": true,
  • "pojo": true,
  • "short": true,
  • "textual": true,
  • "valueNode": true
}

Response samples

Content type
application/json;charset=UTF-8
Copy
Expand all Collapse all
{
  • "data": { },
  • "message": "string",
  • "returnCode": 0
}

Find record by ID

Gets the entity metadata record with the specified ID

Authorizations:
path Parameters
apiVersion
required
string
Example: