Search Links
POST/links/search
Retrieves a list of links by using the search fields below:
Field | Type |
---|---|
type | string |
subtype | string |
from | JSON object |
to | JSON object |
isActive | boolean |
isDefault | boolean |
priority | int |
offset | int (max: 100 , default: 12 ) |
page | int |
Results will be paginated. The default number of links per page is 12
, but can be up to 100
.
Request
- application/json
Body
from
object
class string
ids number[]
offset number
page number
prioritye number
subtype string
to
object
class string
ids number[]
type string
Responses
- 200
- 400
Search Links - 200
Response Headers
Connection
string
Content-Length
string
Date
string
Keep-Alive
string
Return-Format
string
- application/json
- Schema
- Example (from schema)
- Search Links - 200
Schema
Array [
]
data
object[]
dateChanged string
from
object
class string
id number
id number
isActive boolean
isDefault boolean
priority number
subtype string
to
object
class string
id number
type string
end number
itemsFound number
messages string[]
offset number
page number
pages number
start number
total number
{
"data": [
{
"dateChanged": "2018-11-08T11:35:38",
"from": {
"class": "product",
"id": 24603
},
"id": 485377,
"isActive": true,
"isDefault": false,
"priority": 0,
"subtype": "Extrasale",
"to": {
"class": "product",
"id": 27401
},
"type": "accessories"
},
{
"dateChanged": "2018-11-08T11:35:38",
"from": {
"class": "product",
"id": 24603
},
"id": 485378,
"isActive": true,
"isDefault": false,
"priority": 0,
"subtype": "Extrasale",
"to": {
"class": "product",
"id": 24235
},
"type": "accessories"
},
{
"dateChanged": "2018-11-08T11:35:38",
"from": {
"class": "product",
"id": 24603
},
"id": 485379,
"isActive": true,
"isDefault": false,
"priority": 0,
"subtype": "Extrasale",
"to": {
"class": "product",
"id": 24005
},
"type": "accessories"
},
{
"dateChanged": "2018-11-08T11:35:38",
"from": {
"class": "product",
"id": 24603
},
"id": 485380,
"isActive": true,
"isDefault": false,
"priority": 0,
"subtype": "Extrasale",
"to": {
"class": "product",
"id": 24063
},
"type": "accessories"
},
{
"dateChanged": "2018-11-08T11:35:38",
"from": {
"class": "product",
"id": 24603
},
"id": 485381,
"isActive": true,
"isDefault": false,
"priority": 0,
"subtype": "Extrasale",
"to": {
"class": "product",
"id": 24035
},
"type": "accessories"
}
],
"end": 5,
"itemsFound": 5,
"messages": [
"Completed"
],
"offset": 100,
"page": 1,
"pages": 1,
"start": 1,
"total": 5
}
{
"data": [
{
"dateChanged": "2018-11-08T11:35:38",
"from": {
"class": "product",
"id": 24603
},
"id": 485377,
"isActive": true,
"isDefault": false,
"priority": 0,
"subtype": "Extrasale",
"to": {
"class": "product",
"id": 27401
},
"type": "accessories"
},
{
"dateChanged": "2018-11-08T11:35:38",
"from": {
"class": "product",
"id": 24603
},
"id": 485378,
"isActive": true,
"isDefault": false,
"priority": 0,
"subtype": "Extrasale",
"to": {
"class": "product",
"id": 24235
},
"type": "accessories"
},
{
"dateChanged": "2018-11-08T11:35:38",
"from": {
"class": "product",
"id": 24603
},
"id": 485379,
"isActive": true,
"isDefault": false,
"priority": 0,
"subtype": "Extrasale",
"to": {
"class": "product",
"id": 24005
},
"type": "accessories"
},
{
"dateChanged": "2018-11-08T11:35:38",
"from": {
"class": "product",
"id": 24603
},
"id": 485380,
"isActive": true,
"isDefault": false,
"priority": 0,
"subtype": "Extrasale",
"to": {
"class": "product",
"id": 24063
},
"type": "accessories"
},
{
"dateChanged": "2018-11-08T11:35:38",
"from": {
"class": "product",
"id": 24603
},
"id": 485381,
"isActive": true,
"isDefault": false,
"priority": 0,
"subtype": "Extrasale",
"to": {
"class": "product",
"id": 24035
},
"type": "accessories"
}
],
"end": 5,
"itemsFound": 5,
"messages": [
"Completed"
],
"offset": 100,
"page": 1,
"pages": 1,
"start": 1,
"total": 5
}
Search Links - 400
Response Headers
Connection
string
Content-Length
string
Date
string
Return-Format
string
- application/json
- Schema
- Example (from schema)
- Search Links - 400
Schema
error
object
code number
messages string[]
moreInfo string
status number
type string
{
"error": {
"code": 10007,
"messages": [
"#: extraneous key [prioritye] is not permitted"
],
"moreInfo": "https://www.propel.us/docs/errors/10007",
"status": 400,
"type": "SchemaValidationException"
}
}
{
"error": {
"code": 10007,
"messages": [
"#: extraneous key [prioritye] is not permitted"
],
"moreInfo": "https://www.propel.us/docs/errors/10007",
"status": 400,
"type": "SchemaValidationException"
}
}
Loading...