STORM CHANNEL FEED
/
Jobs

Channel Service (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://docs.norce.io/ChannelService/

Exports

Operations

Jobs

Operations

Get Job

Request

Query
jobKeystring(uuid)
Headers
applicationIdinteger or null(int32)
curl -i -X GET \
  https://docs.norce.io/ChannelService/ChannelService/api/v1/jobs/job \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Body
clientIdinteger(int32)
keystring(uuid)
channelKeystring(uuid)
endpointstring or null
typestring or null
deltaFromDatestring or null(date-time)
itemsTotalinteger(int32)
statusIdstring(JobStatus)
Enum"Unknown""Initialized""WaitingForSlot""RunningInExportFeed""CompletedInExportFeed""CompletedByAdapter""NoContent""Failed""Cancelled"
startstring(date-time)
stopstring or null(date-time)
lastUpdatedstring(date-time)
Response
No response example

Get Job

Request

Query
jobKeystring(uuid)
Headers
applicationIdinteger or null(int32)
curl -i -X GET \
  https://docs.norce.io/ChannelService/api/v1/jobs/job \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Body
clientIdinteger(int32)
keystring(uuid)
channelKeystring(uuid)
endpointstring or null
typestring or null
deltaFromDatestring or null(date-time)
itemsTotalinteger(int32)
statusIdstring(JobStatus)
Enum"Unknown""Initialized""WaitingForSlot""RunningInExportFeed""CompletedInExportFeed""CompletedByAdapter""NoContent""Failed""Cancelled"
startstring(date-time)
stopstring or null(date-time)
lastUpdatedstring(date-time)
Response
No response example

Complete Job

Request

Query
jobKeystring(uuid)
itemsProcessedinteger or null(int32)
Headers
applicationIdinteger or null(int32)
curl -i -X PATCH \
  https://docs.norce.io/ChannelService/ChannelService/api/v1/jobs/completejob \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Body
clientIdinteger(int32)
keystring(uuid)
channelKeystring(uuid)
endpointstring or null
typestring or null
deltaFromDatestring or null(date-time)
itemsTotalinteger(int32)
statusIdstring(JobStatus)
Enum"Unknown""Initialized""WaitingForSlot""RunningInExportFeed""CompletedInExportFeed""CompletedByAdapter""NoContent""Failed""Cancelled"
startstring(date-time)
stopstring or null(date-time)
lastUpdatedstring(date-time)
Response
No response example

Complete Job

Request

Query
jobKeystring(uuid)
itemsProcessedinteger or null(int32)
Headers
applicationIdinteger or null(int32)
curl -i -X PATCH \
  https://docs.norce.io/ChannelService/api/v1/jobs/completejob \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Body
clientIdinteger(int32)
keystring(uuid)
channelKeystring(uuid)
endpointstring or null
typestring or null
deltaFromDatestring or null(date-time)
itemsTotalinteger(int32)
statusIdstring(JobStatus)
Enum"Unknown""Initialized""WaitingForSlot""RunningInExportFeed""CompletedInExportFeed""CompletedByAdapter""NoContent""Failed""Cancelled"
startstring(date-time)
stopstring or null(date-time)
lastUpdatedstring(date-time)
Response
No response example

Cancel Job

Request

Query
jobKeystring(uuid)
Headers
applicationIdinteger or null(int32)
curl -i -X PUT \
  https://docs.norce.io/ChannelService/ChannelService/api/v1/jobs/cancel \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Body
clientIdinteger(int32)
keystring(uuid)
channelKeystring(uuid)
endpointstring or null
typestring or null
deltaFromDatestring or null(date-time)
itemsTotalinteger(int32)
statusIdstring(JobStatus)
Enum"Unknown""Initialized""WaitingForSlot""RunningInExportFeed""CompletedInExportFeed""CompletedByAdapter""NoContent""Failed""Cancelled"
startstring(date-time)
stopstring or null(date-time)
lastUpdatedstring(date-time)
Response
No response example

Cancel Job

Request

Query
jobKeystring(uuid)
Headers
applicationIdinteger or null(int32)
curl -i -X PUT \
  https://docs.norce.io/ChannelService/api/v1/jobs/cancel \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Body
clientIdinteger(int32)
keystring(uuid)
channelKeystring(uuid)
endpointstring or null
typestring or null
deltaFromDatestring or null(date-time)
itemsTotalinteger(int32)
statusIdstring(JobStatus)
Enum"Unknown""Initialized""WaitingForSlot""RunningInExportFeed""CompletedInExportFeed""CompletedByAdapter""NoContent""Failed""Cancelled"
startstring(date-time)
stopstring or null(date-time)
lastUpdatedstring(date-time)
Response
No response example