Skip to content

Issue a signed attachment capability after reauthorizing one exact field destination.

POST
/api/workspace/markdown/scope/issue
curl --request POST \
--url https://example.com/api/workspace/markdown/scope/issue \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "ProviderKey": "example", "DefinitionId": "example", "TableId": "example", "FieldId": "example", "ChildRowId": "example", "DestinationModuleKey": "example", "DestinationResourceKind": "example", "DestinationContextResourceId": "example", "DestinationResourceObjectId": "example", "DestinationCreateNonce": "example", "OperationKind": 0, "ProviderContextJson": "example" }'

The scope token travels in the X-Moltaro-Markdown-Scope header of a draft upload, so no scope is issued whose header line (name, ": ", token and line end) would exceed 7,168 bytes. A refusal answers 404 markdown.inline.unavailable, except a core.entity Create scope whose ProviderContextJson (the parent context of a new child) makes that header too large: it answers 400 moltaro.ui.form.parentContext.tooLarge at ProviderContextJson, before any right is decided, with Metadata.Maximum``7168 and Metadata.Length, the header line’s bytes. A context whose own UTF-8 bytes already overfill that line is refused before any token is built; its Length is then the line the context alone would make, a lower bound of the token’s line.

access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Coordinates used by a server host to issue one Markdown attachment capability.

object
ProviderKey
string
nullable
DefinitionId
string
nullable
TableId
string
nullable
FieldId
string
nullable
ChildRowId
string
nullable
DestinationModuleKey
string
nullable
DestinationResourceKind
string
nullable
DestinationContextResourceId
string
nullable
DestinationResourceObjectId
string
nullable
DestinationCreateNonce
string
nullable
OperationKind
integer format: int32
Allowed values: 0 1 2
ProviderContextJson
string
nullable

OK

Media typeapplication/json
object
Data

Server-derived, signed Markdown attachment capability for one field and destination.

object
ScopeToken
string
nullable
RenewalToken
string
nullable
CanReadInline
boolean
CanAttach
boolean
CanSelectCatalog
boolean
MaximumItems
integer format: int32
MaximumAggregateBytes
integer format: int64
ScopeExpiresAt
string format: date-time
RenewalExpiresAt
string format: date-time
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Bad Request

Media typeapplication/json
object
Data

Server-derived, signed Markdown attachment capability for one field and destination.

object
ScopeToken
string
nullable
RenewalToken
string
nullable
CanReadInline
boolean
CanAttach
boolean
CanSelectCatalog
boolean
MaximumItems
integer format: int32
MaximumAggregateBytes
integer format: int64
ScopeExpiresAt
string format: date-time
RenewalExpiresAt
string format: date-time
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/json
object
Data

Server-derived, signed Markdown attachment capability for one field and destination.

object
ScopeToken
string
nullable
RenewalToken
string
nullable
CanReadInline
boolean
CanAttach
boolean
CanSelectCatalog
boolean
MaximumItems
integer format: int32
MaximumAggregateBytes
integer format: int64
ScopeExpiresAt
string format: date-time
RenewalExpiresAt
string format: date-time
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}