---
title: /editAdministrativePolicyForSwagger
slug: editadministrativepolicyforswagger
createdAt: 2024-01-09T12:30:00.566Z
---

{
  "id": "QxGG0wJfwG2OvtAHbcfHm",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "http://1.1.1.1/editAdministrativePolicyForSwagger",
    "servers": [
      {
        "url": "http://1.1.1.1/editAdministrativePolicyForSwagger"
      }
    ],
    "name": "",
    "description": "<p>This API allows to associate the different action types to the corresponding approval workflows.</p>\n<p>The order of the actions in the list defines their importance - from the most important to the less important,\ni.e. if the user did several actions in one session, the chosen approval workflow will be the one associated to\nthe most important action (the one that appears first in the list).</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [],
      "queryParameters": [
        {
          "kind": "required",
          "name": "action_type_and_approval_workflow_ids",
          "type": "object",
          "example": "",
          "description": "List of dictionaries, each representing action details.",
          "default": "{\n  \"please_insert_your_object_data_inside_the_requestBody\": \"your_object_here\"\n}\n",
          "schema": []
        },
        {
          "kind": "required",
          "name": "session_id",
          "type": "string",
          "example": "3478593863424051983840947",
          "description": "the session id of the contract in string",
          "default": "3478593863424051983840947"
        },
        {
          "kind": "required",
          "name": "administrative_message_number",
          "type": "integer",
          "example": 5,
          "description": "the administrative message number",
          "default": 5
        }
      ],
      "bodyDataParameters": [
        {
          "kind": "optional",
          "name": "body",
          "type": "object",
          "customType": "editAdministrativePolicyForSwaggerRequest",
          "schema": [
            {
              "name": "action_type_and_approval_workflow_ids",
              "kind": "optional",
              "type": "string",
              "example": "type_object_here",
              "default": "type_object_here"
            }
          ],
          "modelRef": "#/components/schemas/editAdministrativePolicyForSwaggerRequest",
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "success",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "customType": "editAdministrativePolicyForSwaggerResponse",
            "schema": [
              {
                "name": "FunctionData",
                "kind": "optional",
                "type": "object",
                "example": "",
                "schema": [
                  {
                    "name": "StatusCode",
                    "kind": "optional",
                    "type": "integer",
                    "description": "Status code for the current run",
                    "example": 0,
                    "default": 0
                  }
                ]
              },
              {
                "name": "Meta",
                "kind": "optional",
                "type": "object",
                "modelRef": "#/components/schemas/MetaResponse",
                "customType": "MetaResponse",
                "schema": [
                  {
                    "name": "AccessToken",
                    "kind": "optional",
                    "type": "string",
                    "description": "The new access token generated after this operation",
                    "example": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6",
                    "default": "a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6"
                  },
                  {
                    "name": "Destination",
                    "kind": "optional",
                    "type": "string",
                    "description": "Id of the server",
                    "example": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622",
                    "default": "042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622"
                  },
                  {
                    "name": "Source",
                    "kind": "optional",
                    "type": "string",
                    "description": "User public key",
                    "example": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355",
                    "default": "df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355"
                  },
                  {
                    "name": "Time",
                    "kind": "optional",
                    "type": "string",
                    "description": "UTC Time of execution",
                    "example": "2021-02-14 09:58:52.320",
                    "default": "2021-02-14 09:58:52.320"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/editAdministrativePolicyForSwaggerResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url 'http://1.1.1.1/editAdministrativePolicyForSwagger?action_type_and_approval_workflow_ids=%22{%5Cn%20%20%5C%22please_insert_your_object_data_inside_the_requestBody%5C%22%3A%20%5C%22your_object_here%5C%22%5Cn}%5Cn%22&session_id=3478593863424051983840947&administrative_message_number=5' \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json' \\\n     --data '{\n     \"action_type_and_approval_workflow_ids\": \"type_object_here\"\n     }'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"action_type_and_approval_workflow_ids\": \"type_object_here\"\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"http://1.1.1.1/editAdministrativePolicyForSwagger?action_type_and_approval_workflow_ids=\\\"{\\\\n  \\\\\\\"please_insert_your_object_data_inside_the_requestBody\\\\\\\": \\\\\\\"your_object_here\\\\\\\"\\\\n}\\\\n\\\"&session_id=3478593863424051983840947&administrative_message_number=5\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"http://1.1.1.1/editAdministrativePolicyForSwagger?action_type_and_approval_workflow_ids=\\\"{\\n  \\\\\"please_insert_your_object_data_inside_the_requestBody\\\\\": \\\\\"your_object_here\\\\\"\\n}\\n\\\"&session_id=3478593863424051983840947&administrative_message_number=5\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n   \"action_type_and_approval_workflow_ids\": \"type_object_here\"\n})\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"http://1.1.1.1/editAdministrativePolicyForSwagger?action_type_and_approval_workflow_ids=\\\"{\\\\n  \\\\\\\"please_insert_your_object_data_inside_the_requestBody\\\\\\\": \\\\\\\"your_object_here\\\\\\\"\\\\n}\\\\n\\\"&session_id=3478593863424051983840947&administrative_message_number=5\"\n\npayload = json.dumps({\n   \"action_type_and_approval_workflow_ids\": \"type_object_here\"\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// success\n{\n  \"FunctionData\": {\n    \"StatusCode\": 0\n  },\n  \"Meta\": {\n    \"AccessToken\": \"a3e816b5bc04302d99da94705ec2309a4a63fe10d6aed3c5f6fc9e7ff27c6be6\",\n    \"Destination\": \"042c671aeb148d9b2bb4918399c4c925f3764248c5ab2d5194ab0f32664132834692699a75e7fafb5af35f183b7d8a68bdc3b3e6ebfaff8ab555b9a3caf8090622\",\n    \"Source\": \"df4b76a23067a9d782d09a7372ed526ec713cf6d771fac4dbdb9610f7af36d570a157eed76986b8e85afde12888d10d10bef461399e490f3d7e4db44cde1b6e355\",\n    \"Time\": \"2021-02-14 09:58:52.320\"\n  }\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "id": "jq-Kd67nnSi2WW6YDJMy6",
      "type": "paragraph",
      "children": [
        {
          "text": "This API allows to associate the different action types to the corresponding approval workflows.",
          "id": "DiV92PSYLlL2pbcXXZADX"
        }
      ]
    },
    {
      "id": "BI7QxM8Mh62MLkQRX8ysQ",
      "type": "paragraph",
      "children": [
        {
          "text": "The order of the actions in the list defines their importance - from the most important to the less important,\ni.e. if the user did several actions in one session, the chosen approval workflow will be the one associated to\nthe most important action (the one that appears first in the list).",
          "id": "mgEC16pfMlwpPAjJ3Y_Cg"
        }
      ]
    }
  ]
}