UpsertFederatedResourceRequest
Request to upsert a federated resource
Properties
| Property | Type | Required | Description |
|---|---|---|---|
expires_at |
string,null | No | Optional expiration timestamp |
external_id |
string | Yes | External ID of the resource (unique within publisher + type) |
metadata |
any | Yes | Resource metadata (JSON object with type-specific fields) |
org_database_id |
string,null | No | Optional database ID where the resource data lives |
publisher_slug |
string,null | No | Optional publisher slug for disambiguation when an organization owns multiple publishers |
resource_type |
string | Yes | Type of resource being registered |
status |
string | No | Resource status (default: "active") |
View JSON Schema
{
"type": "object",
"description": "Request to upsert a federated resource",
"required": [
"resource_type",
"external_id",
"metadata"
],
"properties": {
"expires_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Optional expiration timestamp"
},
"external_id": {
"type": "string",
"description": "External ID of the resource (unique within publisher + type)"
},
"metadata": {
"description": "Resource metadata (JSON object with type-specific fields)"
},
"org_database_id": {
"type": [
"string",
"null"
],
"format": "uuid",
"description": "Optional database ID where the resource data lives"
},
"publisher_slug": {
"type": [
"string",
"null"
],
"description": "Optional publisher slug for disambiguation when an organization owns multiple publishers"
},
"resource_type": {
"type": "string",
"description": "Type of resource being registered"
},
"status": {
"type": "string",
"description": "Resource status (default: \"active\")"
}
}
}