Create a smart playlist with a rule criteria

POST /smart-playlists

Create a smart playlist with a rule criteria

cURL

curl --request POST \
  --url http://localhost:6063/smart-playlists \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "rules": {
    "operator": "AND",
    "rules": [
      {
        "field": "<string>",
        "op": "<string>",
        "value": "<unknown>"
      }
    ],
    "sort": {
      "field": "<string>"
    },
    "limit": 123
  },
  "description": "<string>",
  "image": "<string>",
  "folder_id": "<string>"
}
'

import requests

url = "http://localhost:6063/smart-playlists"

payload = {
    "name": "<string>",
    "rules": {
        "operator": "AND",
        "rules": [
            {
                "field": "<string>",
                "op": "<string>",
                "value": "<unknown>"
            }
        ],
        "sort": { "field": "<string>" },
        "limit": 123
    },
    "description": "<string>",
    "image": "<string>",
    "folder_id": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    rules: {
      operator: 'AND',
      rules: [{field: '<string>', op: '<string>', value: '<unknown>'}],
      sort: {field: '<string>'},
      limit: 123
    },
    description: '<string>',
    image: '<string>',
    folder_id: '<string>'
  })
};

fetch('http://localhost:6063/smart-playlists', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "6063",
  CURLOPT_URL => "http://localhost:6063/smart-playlists",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'rules' => [
        'operator' => 'AND',
        'rules' => [
                [
                                'field' => '<string>',
                                'op' => '<string>',
                                'value' => '<unknown>'
                ]
        ],
        'sort' => [
                'field' => '<string>'
        ],
        'limit' => 123
    ],
    'description' => '<string>',
    'image' => '<string>',
    'folder_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:6063/smart-playlists"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"rules\": {\n    \"operator\": \"AND\",\n    \"rules\": [\n      {\n        \"field\": \"<string>\",\n        \"op\": \"<string>\",\n        \"value\": \"<unknown>\"\n      }\n    ],\n    \"sort\": {\n      \"field\": \"<string>\"\n    },\n    \"limit\": 123\n  },\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"folder_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:6063/smart-playlists")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"rules\": {\n    \"operator\": \"AND\",\n    \"rules\": [\n      {\n        \"field\": \"<string>\",\n        \"op\": \"<string>\",\n        \"value\": \"<unknown>\"\n      }\n    ],\n    \"sort\": {\n      \"field\": \"<string>\"\n    },\n    \"limit\": 123\n  },\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"folder_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:6063/smart-playlists")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"rules\": {\n    \"operator\": \"AND\",\n    \"rules\": [\n      {\n        \"field\": \"<string>\",\n        \"op\": \"<string>\",\n        \"value\": \"<unknown>\"\n      }\n    ],\n    \"sort\": {\n      \"field\": \"<string>\"\n    },\n    \"limit\": 123\n  },\n  \"description\": \"<string>\",\n  \"image\": \"<string>\",\n  \"folder_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

201

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "image": "<string>",
  "folder_id": "<string>",
  "rules": {
    "operator": "AND",
    "rules": [
      {
        "field": "<string>",
        "op": "<string>",
        "value": "<unknown>"
      }
    ],
    "sort": {
      "field": "<string>"
    },
    "limit": 123
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Body

application/json

name · string · required

rules · object · required

Smart-playlist rule set. See crates/playlists/src/rules.rs for the canonical definition.

Show child attributes

description · string

image · string

folder_id · string

Response

201

application/json

Created

id · string

name · string

description · string | null

image · string | null

folder_id · string | null

rules · object

Smart-playlist rule set. See crates/playlists/src/rules.rs for the canonical definition.

Show child attributes

created_at · string<date-time>

updated_at · string<date-time>