Noma

Reorder Fields

Reorder Fields

Sets the order value for fields in a collection so they appear in the desired sequence in the editor and when fields are loaded with a collection. Each payload item updates the row whose uuid matches within that collection; unknown UUIDs are skipped without an error.

Request

POST /api/collections/{collection}/fields/reorder HTTP/1.1
Host: app.nomacms.com
Content-Type: application/json
project-id: <project-uuid>
Authorization: Bearer <api-token>
Accept: application/json

{collection} is the collection slug.

Requires the admin ability on the token.

JSON body

FieldTypeRequiredDescription
fieldsarrayYesList of { uuid, order } entries

Each item:

FieldTypeRequiredDescription
uuidstringYesField uuid
ordernumberYesInteger ≥ 0 (used for relative ordering within the collection)

Response (200)

{ "message": "Fields reordered successfully." }

Errors

StatusWhen
400Missing project-id or project cannot be resolved
401Missing or invalid bearer token
403Token does not have admin (or *)
404Collection slug not found (Collection not found.)
422Validation failed (missing fields, invalid items, and so on)
429Rate limited

Example

import { createClient } from "@nomacms/js-sdk"
 
const client = createClient({
  projectId: process.env.NOMA_PROJECT_ID!,
  apiKey: process.env.NOMA_API_KEY!,
})
 
await client.fields.reorder("blog-posts", {
  fields: [
    { uuid: "aaaaaaaa-bbbb-4ccc-dddd-eeeeeeeeeeee", order: 0 },
    { uuid: "bbbbbbbb-bbbb-4ccc-dddd-ffffffffffff", order: 1 },
  ],
})
import axios from "axios"
 
async function main() {
  const { data } = await axios.post(
    "https://app.nomacms.com/api/collections/blog-posts/fields/reorder",
    {
      fields: [
        { uuid: "aaaaaaaa-bbbb-4ccc-dddd-eeeeeeeeeeee", order: 0 },
        { uuid: "bbbbbbbb-bbbb-4ccc-dddd-ffffffffffff", order: 1 },
      ],
    },
    {
      headers: {
        "Content-Type": "application/json",
        "project-id": process.env.NOMA_PROJECT_ID!,
        Authorization: `Bearer ${process.env.NOMA_API_KEY}`,
        Accept: "application/json",
      },
    },
  )
  console.log(data)
}
 
void main()
<?php
 
$payload = json_encode([
    'fields' => [
        ['uuid' => 'aaaaaaaa-bbbb-4ccc-dddd-eeeeeeeeeeee', 'order' => 0],
        ['uuid' => 'bbbbbbbb-bbbb-4ccc-dddd-ffffffffffff', 'order' => 1],
    ],
]);
 
$ch = curl_init('https://app.nomacms.com/api/collections/blog-posts/fields/reorder');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => $payload,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'Content-Length: ' . strlen($payload),
        'project-id: ' . getenv('NOMA_PROJECT_ID'),
        'Authorization: Bearer ' . getenv('NOMA_API_KEY'),
        'Accept: application/json',
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
echo curl_exec($ch);
curl -sS -X POST "https://app.nomacms.com/api/collections/blog-posts/fields/reorder" \
  -H "Content-Type: application/json" \
  -H "project-id: $NOMA_PROJECT_ID" \
  -H "Authorization: Bearer $NOMA_API_KEY" \
  -H "Accept: application/json" \
  -d '{"fields":[{"uuid":"aaaaaaaa-bbbb-4ccc-dddd-eeeeeeeeeeee","order":0},{"uuid":"bbbbbbbb-bbbb-4ccc-dddd-ffffffffffff","order":1}]}'
package main
 
import (
	"bytes"
	"encoding/json"
	"io"
	"net/http"
	"os"
)
 
func main() {
	body := map[string]any{
		"fields": []any{
			map[string]any{"uuid": "aaaaaaaa-bbbb-4ccc-dddd-eeeeeeeeeeee", "order": 0},
			map[string]any{"uuid": "bbbbbbbb-bbbb-4ccc-dddd-ffffffffffff", "order": 1},
		},
	}
	raw, _ := json.Marshal(body)
	req, err := http.NewRequest("POST", "https://app.nomacms.com/api/collections/blog-posts/fields/reorder", bytes.NewReader(raw))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("project-id", os.Getenv("NOMA_PROJECT_ID"))
	req.Header.Set("Authorization", "Bearer "+os.Getenv("NOMA_API_KEY"))
	req.Header.Set("Accept", "application/json")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	_, _ = io.Copy(os.Stdout, res.Body)
}
require "net/http"
require "json"
require "uri"
 
uri = URI("https://app.nomacms.com/api/collections/blog-posts/fields/reorder")
req = Net::HTTP::Post.new(uri)
req["Content-Type"] = "application/json"
req["project-id"] = ENV.fetch("NOMA_PROJECT_ID")
req["Authorization"] = "Bearer #{ENV.fetch('NOMA_API_KEY')}"
req["Accept"] = "application/json"
req.body = JSON.generate({
  "fields" => [
    { "uuid" => "aaaaaaaa-bbbb-4ccc-dddd-eeeeeeeeeeee", "order" => 0 },
    { "uuid" => "bbbbbbbb-bbbb-4ccc-dddd-ffffffffffff", "order" => 1 }
  ]
})
 
Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  puts http.request(req).body
end
import json
import os
import urllib.request
 
payload = {
    "fields": [
        {"uuid": "aaaaaaaa-bbbb-4ccc-dddd-eeeeeeeeeeee", "order": 0},
        {"uuid": "bbbbbbbb-bbbb-4ccc-dddd-ffffffffffff", "order": 1},
    ]
}
data = json.dumps(payload).encode()
req = urllib.request.Request(
    "https://app.nomacms.com/api/collections/blog-posts/fields/reorder",
    data=data,
    headers={
        "Content-Type": "application/json",
        "project-id": os.environ["NOMA_PROJECT_ID"],
        "Authorization": f"Bearer {os.environ['NOMA_API_KEY']}",
        "Accept": "application/json",
    },
    method="POST",
)
with urllib.request.urlopen(req) as res:
    print(res.read().decode())
  • Authentication - Abilities (admin)
  • List Collections - Fields appear in collection order
  • JavaScript SDK - fields.reorder

Search documentation

Find guides and reference pages