Status Skill Card
A Box Skill metadata card that puts a status message in the metadata sidebar.
skill_cardskill_card
Value is always skill_card
2018-04-13T13:53:23-07:00The optional date and time this card was created at.
The invocation of this service, used to track which instance of a service applied the metadata.
image-recognition-service-123A custom identifier that represent the instance of
the service that applied this metadata. For example,
if your image-recognition-service runs on multiple
nodes, this field can be used to identify the ID of
the node that was used to apply the metadata.
skill_invocationskill_invocation
Value is always skill_invocation
The service that applied this metadata.
image-recognition-serviceA custom identifier that represent the service that applied this metadata.
serviceservice
Value is always service
The title of the card.
statusAn optional identifier for the title.
StatusThe actual title to show in the UI.
statusstatus
Value is always status
Sets the status of the skill. This can be used to show a message to the user while the Skill is processing the data, or if it was not able to process the file.
successA code for the status of this Skill invocation. By
default each of these will have their own accompanied
messages. These can be adjusted by setting the message
value on this object.
Value is one of invoked,processing,success,transient_failure,permanent_failure
We're preparing to process your file. Please hold on!A custom message that can be provided with this status. This will be shown in the web app to the end user.
Response Example
{
"type": "skill_card",
"created_at": "2018-04-13T13:53:23-07:00",
"invocation": {
"id": "image-recognition-service-123",
"type": "skill_invocation"
},
"skill": {
"id": "image-recognition-service",
"type": "service"
},
"skill_card_title": {
"code": "status",
"message": "Status"
},
"skill_card_type": "status",
"status": {
"code": "success",
"message": "We're preparing to process your file. Please hold on!"
}
}