Project Management via the V6 REST-API

Introduction 

 The V6 REST-API provides administrators with the ability to manage projects efficiently. Using the /Projects endpoint, projects can be created, retrieved, updated, and deleted. Additionally, projects can be filtered using various parameters. 

 Endpoint 

 

 

 For Admins: https://SUBDOMAIN.de/ws/V6/admin/JSON/Projects 

 

 

 

 Parameters & Filters 

 Required Parameters (for POST and PUT) 

 

 

 

 Parameter 

 Type 

 Description 

 

 

 

 

 title 

 String 

 Title of the project (Mandatory) 

 

 

 status 

 Integer 

 Status of the project (Mandatory) 

 

 

 url 

 String 

 URL of the project (Mandatory) 

 

 

 

 Filter Options (for GET) 

 Filtering can be applied to any column in the publisher.projects table, such as: 

 

 

 id 

 

 

 status 

 

 

 publisher_id 

 

 

 projecttype 

 

 

 title 

 

 

 url 

 

 

 channel_id 

 

 

 hidden 

 

 

 Example of a GET request with filters: 

 

 

 

 Bash 

 

 

 

 

 

 

 

 curl -X GET -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" "https://SUBDOMAIN.de/ws/V6/admin/JSON/Projects?status=1&publisher_id=10"

 

 

 

 

 

 

 

 

 

 CRUD Operations 

 GET: Retrieve Projects 

 Retrieve a list of projects or a specific project by its id . 

 

 

 

 Bash 

 

 

 

 

 

 

 

 curl -X GET -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" "https://SUBDOMAIN.de/ws/V6/admin/JSON/Projects?id=5"

 

 

 

 

 

 

 

 

 POST: Create a New Project 

 

 

 

 Bash 

 

 

 

 

 

 

 

 curl -X POST -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" -d '{

 "title": "New Project",

 "status": 1,

 "url": "https://example.com"

}' "https://SUBDOMAIN.de/ws/V6/admin/JSON/Projects"

 

 

 

 

 

 

 

 

 PUT: Update an Existing Project 

 

 

 

 Bash 

 

 

 

 

 

 

 

 curl -X PUT -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" -d '{

 "id": 5,

 "title": "Modified Project",

 "status": 2,

 "url": "https://updated-example.com"

}' "https://SUBDOMAIN.de/ws/V6/admin/JSON/Projects"

 

 

 

 

 

 

 

 

 DELETE: Delete a Project 

 Delete a project by its id . 

 

 

 

 Bash 

 

 

 

 

 

 

 

 curl -X DELETE -H "Content-Type: application/json" -H "X-Network-ID: -1" -H "X-Auth-Token: ADMIN_APIUSER_TOKEN" -H "X-Auth-ID: ADMIN_APIUSER_LOGIN_ID" "https://SUBDOMAIN.de/ws/V6/admin/JSON/Projects?id=5"

 

 

 

 

 

 

 

 

 

 Responses 

 Successful Response 

 

 

 

 JSON 

 

 

 

 

 

 

 

 {

 "id": 5,

 "status": 1,

 "publisher_id": 10,

 "projecttype": "page",

 "title": "Project Example",

 "description": "Description of the project",

 "url": "https://example.com",

 "channel_id": 2,

 "project_identifier_string": "abc123",

 "reach": "1000",

 "statistic_type": "internal",

 "external_sources_entity_id": "-1",

 "trackingtemplate": "template",

 "kpi_whitelist": "kpi1,kpi2",

 "hidden": false,

 "login_type": "pub",

 "exclude_from_salary": 0,

 "default_project": false,

 "insert_timestamp": "2025-01-27T12:00:00"

}

 

 

 

 

 

 

 

 

 Bad Request 

 

 

 

 JSON 

 

 

 

 

 

 

 

 {

 "error": "Missing required field: title"

}

 

 

 

 

 

 

 

 

 

 📘 Error Handling Notes 

 

 

 If mandatory fields ( title , status , url ) are missing, an appropriate error message will be returned. 

 

 

 An invalid or non-existent id during a GET , PUT , or DELETE request will result in an empty response or an error message.