From 1b780c4c44900ed751916a49100732edf721e6c5 Mon Sep 17 00:00:00 2001 From: Meik Date: Wed, 1 Jul 2026 09:08:12 +0200 Subject: [PATCH] test: add postman collection for web api --- ...4IT-F4SD-M42WebApi.postman_collection.json | 886 ++++++++++++++++++ 1 file changed, 886 insertions(+) create mode 100644 docs/postman/C4IT-F4SD-M42WebApi.postman_collection.json diff --git a/docs/postman/C4IT-F4SD-M42WebApi.postman_collection.json b/docs/postman/C4IT-F4SD-M42WebApi.postman_collection.json new file mode 100644 index 0000000..bb9bece --- /dev/null +++ b/docs/postman/C4IT-F4SD-M42WebApi.postman_collection.json @@ -0,0 +1,886 @@ +{ + "info": { + "_postman_id": "3c5d2c5b-26e1-4d8e-bf4c-f4sdm42webapi", + "name": "C4IT F4SD M42 WebApi", + "description": "Systematic smoke-test collection for all active endpoints in F4SDM42WebApiController. Configure the collection variables before running. The default baseUrl includes /m42Services.", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" + }, + "auth": { + "type": "ntlm", + "ntlm": [ + { + "key": "username", + "value": "{{ntlmUsername}}", + "type": "string" + }, + { + "key": "password", + "value": "{{ntlmPassword}}", + "type": "string" + }, + { + "key": "domain", + "value": "{{ntlmDomain}}", + "type": "string" + }, + { + "key": "workstation", + "value": "{{ntlmWorkstation}}", + "type": "string" + } + ] + }, + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "pm.test(\"No unhandled 5xx server error\", function () {", + " pm.expect(pm.response.code).to.be.below(500);", + "});", + "", + "if (pm.response.text()) {", + " pm.test(\"Response body is valid JSON when JSON content is returned\", function () {", + " const contentType = pm.response.headers.get(\"Content-Type\") || \"\";", + " if (contentType.toLowerCase().includes(\"json\")) {", + " pm.response.to.be.json;", + " }", + " });", + "}" + ] + } + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://srvwsm001.imagoverum.com/m42Services" + }, + { + "key": "ntlmDomain", + "value": "imagoverum" + }, + { + "key": "ntlmUsername", + "value": "" + }, + { + "key": "ntlmPassword", + "value": "" + }, + { + "key": "ntlmWorkstation", + "value": "" + }, + { + "key": "sid", + "value": "S-1-5-21-735677975-861733296-3045004705-8205" + }, + { + "key": "upn", + "value": "" + }, + { + "key": "userId", + "value": "00000000-0000-0000-0000-000000000000" + }, + { + "key": "ticketObjectId", + "value": "00000000-0000-0000-0000-000000000000" + }, + { + "key": "objectType", + "value": "SPSActivityTypeIncident" + }, + { + "key": "assetName", + "value": "" + }, + { + "key": "hours", + "value": "9999" + }, + { + "key": "scope", + "value": "personal" + }, + { + "key": "overviewKey", + "value": "open" + }, + { + "key": "overviewKeys", + "value": "open,overdue" + }, + { + "key": "queueOption", + "value": "0" + }, + { + "key": "queues", + "value": "" + }, + { + "key": "roleGuid", + "value": "00000000-0000-0000-0000-000000000000" + }, + { + "key": "pickupName", + "value": "DWPUseCasePickup" + }, + { + "key": "pickupMode", + "value": "None" + }, + { + "key": "pickupGroup", + "value": "-1" + }, + { + "key": "logCount", + "value": "50" + }, + { + "key": "logFilter", + "value": "" + }, + { + "key": "logEntryId", + "value": "0" + } + ], + "item": [ + { + "name": "01 Health and diagnostics", + "item": [ + { + "name": "isAlive returns 204 No Content", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "pm.test(\"isAlive returns 204\", function () {", + " pm.response.to.have.status(204);", + "});", + "pm.test(\"No response body\", function () {", + " pm.expect(pm.response.text()).to.equal(\"\");", + "});" + ] + } + } + ], + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/isAlive", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "isAlive" + ] + } + } + }, + { + "name": "loglevel enable debug", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "text/plain" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/loglevel?debug=1", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "loglevel" + ], + "query": [ + { + "key": "debug", + "value": "1" + } + ] + } + } + }, + { + "name": "loglevel reset info", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "text/plain" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/loglevel?debug=0", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "loglevel" + ], + "query": [ + { + "key": "debug", + "value": "0" + } + ] + } + } + }, + { + "name": "log text response", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/log?download=0&count={{logCount}}&filter={{logFilter}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "log" + ], + "query": [ + { + "key": "download", + "value": "0" + }, + { + "key": "count", + "value": "{{logCount}}" + }, + { + "key": "filter", + "value": "{{logFilter}}" + } + ] + } + } + }, + { + "name": "log file download", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/log?download=1&count={{logCount}}&filter={{logFilter}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "log" + ], + "query": [ + { + "key": "download", + "value": "1" + }, + { + "key": "count", + "value": "{{logCount}}" + }, + { + "key": "filter", + "value": "{{logFilter}}" + } + ] + } + } + } + ] + }, + { + "name": "02 Tickets", + "item": [ + { + "name": "getTicketList by SID", + "event": [ + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "pm.test(\"Ticket list is array or null\", function () {", + " const text = pm.response.text();", + " if (!text) return;", + " const json = pm.response.json();", + " pm.expect(json === null || Array.isArray(json)).to.equal(true);", + "});" + ] + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/getTicketList?sid={{sid}}&hours={{hours}}&queueoption={{queueOption}}&queues={{queues}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "getTicketList" + ], + "query": [ + { + "key": "sid", + "value": "{{sid}}" + }, + { + "key": "hours", + "value": "{{hours}}" + }, + { + "key": "queueoption", + "value": "{{queueOption}}" + }, + { + "key": "queues", + "value": "{{queues}}" + } + ] + } + } + }, + { + "name": "getTicketDetails by objectId", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/getTicketDetails?objectId={{ticketObjectId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "getTicketDetails" + ], + "query": [ + { + "key": "objectId", + "value": "{{ticketObjectId}}" + } + ] + } + } + }, + { + "name": "getTicketHistory by objectId", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/getTicketHistory?objectId={{ticketObjectId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "getTicketHistory" + ], + "query": [ + { + "key": "objectId", + "value": "{{ticketObjectId}}" + } + ] + } + } + }, + { + "name": "getDirectLinkCreateTicket", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/getDirectLinkCreateTicket?sid={{sid}}&assetname={{assetName}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "getDirectLinkCreateTicket" + ], + "query": [ + { + "key": "sid", + "value": "{{sid}}" + }, + { + "key": "assetname", + "value": "{{assetName}}" + } + ] + } + } + }, + { + "name": "getDirectLinkF4SD", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "text/plain" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/getDirectLinkF4SD?EOID={{ticketObjectId}}&Type={{objectType}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "getDirectLinkF4SD" + ], + "query": [ + { + "key": "EOID", + "value": "{{ticketObjectId}}" + }, + { + "key": "Type", + "value": "{{objectType}}" + } + ] + } + } + } + ] + }, + { + "name": "03 Ticket overview", + "item": [ + { + "name": "getTicketOverviewCounts", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/getTicketOverviewCounts?sid={{sid}}&scope={{scope}}&keys={{overviewKeys}}&queueoption={{queueOption}}&queues={{queues}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "getTicketOverviewCounts" + ], + "query": [ + { + "key": "sid", + "value": "{{sid}}" + }, + { + "key": "scope", + "value": "{{scope}}" + }, + { + "key": "keys", + "value": "{{overviewKeys}}" + }, + { + "key": "queueoption", + "value": "{{queueOption}}" + }, + { + "key": "queues", + "value": "{{queues}}" + } + ] + } + } + }, + { + "name": "getTicketOverviewCountsByRoles", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"Sid\": \"{{sid}}\",\r\n \"RoleGuids\": [\r\n \"{{roleGuid}}\"\r\n ],\r\n \"Keys\": [\r\n \"open\",\r\n \"overdue\"\r\n ],\r\n \"QueueOption\": {{queueOption}},\r\n \"Queues\": \"{{queues}}\"\r\n}" + }, + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/getTicketOverviewCountsByRoles", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "getTicketOverviewCountsByRoles" + ] + } + } + }, + { + "name": "getTicketOverviewRelations", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/getTicketOverviewRelations?sid={{sid}}&scope={{scope}}&key={{overviewKey}}&count=25&queueoption={{queueOption}}&queues={{queues}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "getTicketOverviewRelations" + ], + "query": [ + { + "key": "sid", + "value": "{{sid}}" + }, + { + "key": "scope", + "value": "{{scope}}" + }, + { + "key": "key", + "value": "{{overviewKey}}" + }, + { + "key": "count", + "value": "25" + }, + { + "key": "queueoption", + "value": "{{queueOption}}" + }, + { + "key": "queues", + "value": "{{queues}}" + } + ] + } + } + } + ] + }, + { + "name": "04 Pickups and roles", + "item": [ + { + "name": "getPickup by name", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/getPickup/{{pickupName}}?mode={{pickupMode}}&group={{pickupGroup}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "getPickup", + "{{pickupName}}" + ], + "query": [ + { + "key": "mode", + "value": "{{pickupMode}}" + }, + { + "key": "group", + "value": "{{pickupGroup}}" + } + ] + } + } + }, + { + "name": "getMyRoleMemberships current user", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/getMyRoleMemberships", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "getMyRoleMemberships" + ] + } + } + }, + { + "name": "getRoleMemberships by SID", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/getRoleMemberships?sid={{sid}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "getRoleMemberships" + ], + "query": [ + { + "key": "sid", + "value": "{{sid}}" + } + ] + } + } + }, + { + "name": "getRoleMemberships by UPN", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/getRoleMemberships?upn={{upn}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "getRoleMemberships" + ], + "query": [ + { + "key": "upn", + "value": "{{upn}}" + } + ] + } + } + }, + { + "name": "getRoleMemberships by user id", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/getRoleMemberships?id={{userId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "getRoleMemberships" + ], + "query": [ + { + "key": "id", + "value": "{{userId}}" + } + ] + } + } + } + ] + }, + { + "name": "05 Logs OData", + "item": [ + { + "name": "Logs list", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/logs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "logs" + ] + } + } + }, + { + "name": "Logs list filtered", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/logs?$filter={{logFilter}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "logs" + ], + "query": [ + { + "key": "$filter", + "value": "{{logFilter}}" + } + ] + } + } + }, + { + "name": "Logs count", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/logs/$count", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "logs", + "$count" + ] + } + } + }, + { + "name": "Logs get by id", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/c4itf4sdwebapi/logs/{{logEntryId}}", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "c4itf4sdwebapi", + "logs", + "{{logEntryId}}" + ] + } + } + } + ] + } + ] +}