API
Data API
Tasks
methods allow you to get a list of portal tasks or information on a specific task get get /tasks return a list of tasks { "tab" "request", "url" "https //instance name/api/data/v1 0/tasks/", "name" "request example", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format " } ], "bodydataparameters" \[ { "kind" "optional", "name" "limit", "type" "integer", "description" "the number of results to return per page " }, { "kind" "optional", "name" "offset", "type" "integer", "description" "the initial index from which to return the results " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "fj3zsbaijz6tuvfi40xny", "code" "{\n \\"count\\" 45,\n \\"next\\"\ null,\n \\"previous\\" \\"https //test eyrene com/api/data/tasks/?limit=30\&offset=30\\",\n \\"results\\" \[\n {\n \\"id\\" 111,\n \\"name\\" \\"coffee home shelf\\",\n \\"short description\\"\ null,\n \\"long description\\" \\"\\",\n \\"is enabled\\"\ true,\n \\"is required\\"\ false\n },\n {\n \\"id\\" 125,\n \\"name\\" \\"required photo task\\",\n \\"short description\\" \\"i am a task, you know what to do\\",\n \\"long description\\" \\"enjoy sea reveal brother fall owner speak pass heart she \\\r\\\ncut piece purpose free opportunity around writer whether central improve point personal service only western physical another \\",\n \\"is enabled\\"\ false,\n \\"is required\\"\ false\n },\n {\n \\"id\\" 152,\n \\"name\\" \\"required task\\",\n \\"short description\\" \\"i am a task, you know what to do\\",\n \\"long description\\" \\"response school trial western ago phone develop attorney former management form time gas \\\r\\\nrace this better perhaps child together many customer national without common your \\",\n \\"is enabled\\"\ false,\n \\"is required\\"\ true\n }\\" \\"\n ]\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "fj3zsbaijz6tuvfi40xny" }, "examples" { "languages" \[ { "id" "dpmodah zaotktusexn5x", "code" "curl –i –x get\n https //test eyrene com/api/data/v1 0/tasks/\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "dpmodah zaotktusexn5x" }, "description" "get /tasks", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } response parameters ​ https //help inspector cloud com/en/docs/api/backend/methods/v1/agents/agents list#response definitions count integer the number of tasks next string (uri) nullable nullable next page previous string (uri) nullable nullable previous page results array of objects an array of objects with information about manufacturers id integer task id name string \[ 1 255 ] characters \[ 1 255 ] characters task name short description string <= 255 characters nullable <= 255 characters nullable task short description long description string nullable nullable task full description is enabled boolean task enabled or disabled is required boolean the required task to be completed get get /tasks/{id} returns information about sku by id { "tab" "request", "url" "https //instance name/api/data/v1 0/tasks/{id}", "name" "request example", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "task id " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "description" "string in \\"token xxxxxx \\" format" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "fj3zsbaijz6tuvfi40xny", "code" "{\n \\"id\\" 125,\n \\"name\\" \\"required photo task\\",\n \\"short description\\" \\"i am a task, you know what to do\\",\n \\"long description\\" \\"enjoy sea reveal brother fall owner speak pass heart she \\\r\\\ncut piece purpose free opportunity around writer whether central improve point personal service only western physical another \\",\n \\"is enabled\\"\ false,\n \\"is required\\"\ false\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "fj3zsbaijz6tuvfi40xny" }, "examples" { "languages" \[ { "id" "dpmodah zaotktusexn5x", "code" "curl –i –x get\n https //test eyrene com/api/data/v1 0/tasks/125/\n h ‘authorization token 39fbb6e9 fbf9 459a 9e1b 416dbcf51875e’", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "dpmodah zaotktusexn5x" }, "description" "get /sku/{id}", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } response parameters id integer task id name string \[ 1 255 ] characters \[ 1 255 ] characters task name short description string <= 255 characters nullable <= 255 characters nullable task short description long description string nullable nullable task full description is enabled boolean task enabled or disabled is required boolean the required task to be completed