SendTaskFactory
List SendTaskFactories
GET https://api.idol.io/api/v2/send-task-factories
Headers
Name
Type
Description
Authorization*
string
Bearer <token>
Content-Type*
string
application/vnd.api+json
{
"data": [
{
"id": "<ID>",
"type": "send-task-factories",
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>"
},
"attributes": {
"created-at": "2024-04-08T16:00:32.215+02:00",
"updated-at": "2024-12-18T11:37:09.679+01:00",
"delivery-type": "delivery",
"all-releases": false,
"add-rights": false,
"remove-rights": false,
"deliverable": false,
"send-date": null,
"release-date": null,
"upcs": "",
"priority": null,
"name": null,
"comment": null,
"send-tasks-count": 0,
"send-tasks-completed-count": 0,
"send-tasks-waiting-count": 0,
"send-tasks-sending-count": 0,
"send-tasks-error-count": 0,
"send-tasks-stuck-count": 0,
},
"relationships": {
"distributor": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/distributor",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/distributor"
},
"data": {
"type": "distributors",
"id": "<ID>"
}
},
"user": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/user",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/user"
},
"data": {
"type": "users",
"id": "<ID>"
}
},
"price-code": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/price-code",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/price-code"
},
"data": {
"type": "distributor-price-codes",
"id": "<ID>"
}
},
"target": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/target",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/target"
},
"data": {
"type": "distributors",
"id": "<ID>"
}
},
"dsp-upload-identifications": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/dsp-upload-identifications",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/dsp-upload-identifications"
}
},
"send-tasks": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/send-tasks",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/send-tasks"
}
},
"logs": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/logs",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/logs"
}
}
}
},
{
"id": "<ID>",
"type": "send-task-factories",
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>"
},
"attributes": {
"created-at": "2024-04-08T16:01:18.413+02:00",
"updated-at": "2024-12-18T11:37:09.689+01:00",
"delivery-type": "delivery",
"all-releases": false,
"add-rights": true,
"remove-rights": false,
"deliverable": false,
"send-date": null,
"release-date": null,
"upcs": "",
"priority": null,
"name": null,
"comment": null,
"send-tasks-count": 0,
"send-tasks-completed-count": 0,
"send-tasks-waiting-count": 0,
"send-tasks-sending-count": 0,
"send-tasks-error-count": 0,
"send-tasks-stuck-count": 0,
},
"relationships": {
"distributor": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/distributor",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/distributor"
},
"data": {
"type": "distributors",
"id": "<ID>"
}
},
"user": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/user",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/user"
},
"data": {
"type": "users",
"id": "<ID>"
}
},
"price-code": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/price-code",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/price-code"
},
"data": null
},
"target": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/target",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/target"
},
"data": {
"type": "distributors",
"id": "<ID>"
}
},
"dsp-upload-identifications": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/dsp-upload-identifications",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/dsp-upload-identifications"
}
},
"send-tasks": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/send-tasks",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/send-tasks"
}
},
"logs": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/logs",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/logs"
}
}
}
},
{
"id": "<ID>",
"type": "send-task-factories",
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>"
},
"attributes": {
"created-at": "2024-04-09T16:56:14.628+02:00",
"updated-at": "2024-12-18T11:37:09.699+01:00",
"delivery-type": "delivery",
"all-releases": false,
"add-rights": false,
"remove-rights": false,
"deliverable": false,
"send-date": null,
"release-date": null,
"upcs": "",
"priority": null,
"name": null,
"comment": null,
"send-tasks-count": 1,
"send-tasks-completed-count": 0,
"send-tasks-waiting-count": 1,
"send-tasks-sending-count": 0,
"send-tasks-error-count": 0,
"send-tasks-stuck-count": 0,
},
"relationships": {
"distributor": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/distributor",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/distributor"
},
"data": {
"type": "distributors",
"id": "<ID>"
}
},
"user": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/user",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/user"
},
"data": {
"type": "users",
"id": "<ID>"
}
},
"price-code": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/price-code",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/price-code"
},
"data": null
},
"target": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/target",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/target"
},
"data": {
"type": "distributors",
"id": "<ID>"
}
},
"dsp-upload-identifications": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/dsp-upload-identifications",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/dsp-upload-identifications"
}
},
"send-tasks": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/send-tasks",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/send-tasks"
}
},
"logs": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/logs",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/logs"
}
}
}
},
{
"id": "<ID>",
"type": "send-task-factories",
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>"
},
"attributes": {
"created-at": "2024-04-10T16:07:59.706+02:00",
"updated-at": "2024-12-18T11:37:09.778+01:00",
"delivery-type": "update",
"all-releases": false,
"add-rights": false,
"remove-rights": false,
"deliverable": false,
"send-date": null,
"release-date": null,
"upcs": null,
"priority": null,
"name": null,
"comment": null,
"send-tasks-count": 0,
"send-tasks-completed-count": 0,
"send-tasks-waiting-count": 0,
"send-tasks-sending-count": 0,
"send-tasks-error-count": 0,
"send-tasks-stuck-count": 0,
},
"relationships": {
"distributor": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/distributor",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/distributor"
},
"data": {
"type": "distributors",
"id": "<ID>"
}
},
"user": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/user",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/user"
},
"data": {
"type": "users",
"id": "<ID>"
}
},
"price-code": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/price-code",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/price-code"
},
"data": null
},
"target": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/target",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/target"
},
"data": {
"type": "products",
"id": "<ID>"
}
},
"dsp-upload-identifications": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/dsp-upload-identifications",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/dsp-upload-identifications"
}
},
"send-tasks": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/send-tasks",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/send-tasks"
}
},
"logs": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/logs",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/logs"
}
}
}
},
{
"id": "<ID>",
"type": "send-task-factories",
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>"
},
"attributes": {
"created-at": "2024-04-10T18:13:41.256+02:00",
"updated-at": "2024-12-18T11:37:09.798+01:00",
"delivery-type": "update",
"all-releases": false,
"add-rights": false,
"remove-rights": false,
"deliverable": true,
"send-date": null,
"release-date": null,
"upcs": null,
"priority": null,
"name": null,
"comment": null,
"send-tasks-count": 35,
"send-tasks-completed-count": 34,
"send-tasks-waiting-count": 1,
"send-tasks-sending-count": 0,
"send-tasks-error-count": 0,
"send-tasks-stuck-count": 0,
},
"relationships": {
"distributor": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/distributor",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/distributor"
},
"data": {
"type": "distributors",
"id": "<ID>"
}
},
"user": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/user",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/user"
},
"data": {
"type": "users",
"id": "<ID>"
}
},
"price-code": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/price-code",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/price-code"
},
"data": null
},
"target": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/target",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/target"
},
"data": {
"type": "products",
"id": "<ID>"
}
},
"dsp-upload-identifications": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/dsp-upload-identifications",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/dsp-upload-identifications"
}
},
"send-tasks": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/send-tasks",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/send-tasks"
}
},
"logs": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/logs",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/logs"
}
}
}
},
],
"meta": {
"record-count": XXX,
"page-count": XXX
},
"links": {
"first": "https://api.idol.io/api/v2/send-task-factories?page%5Bnumber%5D=1&page%5Bsize%5D=20",
"next": "https://api.idol.io/api/v2/send-task-factories?page%5Bnumber%5D=2&page%5Bsize%5D=20",
"last": "https://api.idol.io/api/v2/send-task-factories?page%5Bnumber%5D=2000&page%5Bsize%5D=20"
}
}Filter resources
api/v2/send-task-factories?filter[product-ids]=1,2api/v2/send-task-factories?filter[dsp-ids]=1,2api/v2/send-task-factories?filter[label-ids]=1,2api/v2/send-task-factories?filter[company-ids]=1,2# delivery
# update
# redelivery
# delete
api/v2/send-task-factories?filter[delivery-type]=updateapi/v2/send-task-factories?filter[start]=2020-01-01api/v2/send-task-factories?filter[end]=2020-01-01Get SendTaskFactory
GET https://api.idol.io/api/v2/send-task-factories/:id
Path Parameters
Name
Type
Description
id*
string
ID of the SendTaskFactory
Headers
Name
Type
Description
Authorization*
string
Bearer <token>
Content-Type*
string
application/vnd.api+json
{
"data": {
"id": "<ID>",
"type": "send-task-factories",
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>"
},
"attributes": {
"created-at": "2024-04-08T16:00:32.215+02:00",
"updated-at": "2024-12-18T11:37:09.679+01:00",
"delivery-type": "delivery",
"all-releases": false,
"add-rights": false,
"remove-rights": false,
"deliverable": false,
"send-date": null,
"release-date": null,
"upcs": "8634152389624\n5294678938997\n7855380292138",
"priority": null,
"name": null,
"comment": null,
"send-tasks-count": 0,
"send-tasks-completed-count": 0,
"send-tasks-waiting-count": 0,
"send-tasks-sending-count": 0,
"send-tasks-error-count": 0,
"send-tasks-stuck-count": 0
},
"relationships": {
"distributor": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/distributor",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/distributor"
},
"data": {
"type": "distributors",
"id": "<ID>"
}
},
"user": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/user",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/user"
},
"data": {
"type": "users",
"id": "<ID>"
}
},
"price-code": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/price-code",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/price-code"
},
"data": {
"type": "distributor-price-codes",
"id": "<ID>"
}
},
"target": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/target",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/target"
},
"data": {
"type": "distributors",
"id": "<ID>"
}
},
"dsp-upload-identifications": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/dsp-upload-identifications",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/dsp-upload-identifications"
}
},
"send-tasks": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/send-tasks",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/send-tasks"
}
},
"logs": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/logs",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/logs"
}
}
}
}
}Create SendTaskFactory
POST https://api.idol.io/api/v2/send-task-factories
Headers
Name
Type
Description
Authorization*
string
Bearer <token>
Content-Type*
string
application/vnd.api+json
Request Body
Name
Type
Description
distributor*
object
Distributor Object
user*
object
User Object
price-code
object
DistributorPriceCode Object
target*
object
Polymorphic - Distributor / Company / label / Product Object
dsp-upload_identifications*
object
DspUploadIdentfication Object
delivery-type*
string
delivery / update / redelivery / delete
all-releases
boolean
false
add-rights
boolean
false
remove-rights
boolean
false
send-date
string
2024-01-01
release-date
string
2024-01-01
upcs
string
8734983746536\n94837483746384\n3493847562987
name
string
My awesome send task factory
comment
object
This is a comment
deliverable*
boolean
true
{
"data": {
"id": "<ID>",
"type": "send-task-factories",
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>"
},
"attributes": {
"created-at": "2024-04-08T16:00:32.215+02:00",
"updated-at": "2024-12-18T11:37:09.679+01:00",
"delivery-type": "delivery",
"all-releases": false,
"add-rights": false,
"remove-rights": false,
"deliverable": false,
"send-date": '2024-12-18',
"release-date": null,
"upcs": "8634152389624\n5294678938997\n7855380292138",
"priority": null,
"name": 'My awesome send task factory',
"comment": 'This is a comment',
"send-tasks-count": 0,
"send-tasks-completed-count": 0,
"send-tasks-waiting-count": 0,
"send-tasks-sending-count": 0,
"send-tasks-error-count": 0,
"send-tasks-stuck-count": 0
},
"relationships": {
"distributor": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/distributor",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/distributor"
},
"data": {
"type": "distributors",
"id": "<ID>"
}
},
"user": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/user",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/user"
},
"data": {
"type": "users",
"id": "<ID>"
}
},
"price-code": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/price-code",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/price-code"
},
"data": {
"type": "distributor-price-codes",
"id": "<ID>"
}
},
"target": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/target",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/target"
},
"data": {
"type": "distributors",
"id": "<ID>"
}
},
"dsp-upload-identifications": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/dsp-upload-identifications",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/dsp-upload-identifications"
}
},
"send-tasks": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/send-tasks",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/send-tasks"
}
},
"logs": {
"links": {
"self": "https://api.idol.io/api/v2/send-task-factories/<ID>/relationships/logs",
"related": "https://api.idol.io/api/v2/send-task-factories/<ID>/logs"
}
}
}
}
}Last updated