{"_id":"5bba714c7ba7710003bd9098","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":35,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e","5b258091bc7a6700033b9cb5","5b26e48e024807000315a740","5b44edff3306680003663f5c","5b468abd3d4a9e0003789111","5b468d8f3dcb6a0003c6e374","5b47b0b93d4a9e000378a33a","5b538d114ea24f00033c726f","5b6a0efe402b32000336c33f","5bba5e5d7ba7710003bd902a","5bc2703349ac3a0013eec3e5","5c351061191e2b002b4988a8","5c8b01b199b56e00440aa018"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"5bba5e5d7ba7710003bd902a","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-10-07T19:28:29.644Z","from_sync":false,"order":25,"slug":"territories-api","title":"Territories API"},"user":"5a6a26281895510045b2cd40","__v":12,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-10-07T20:49:16.687Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"POST https://ioe.droplit.io/api/territories/T57b26c89a14fa832caa75bd1 HTTP/1.1\nauthorization: AUTH_TOKEN\ncontent-type: application/json\n\n{\n\t\"itemType\" : \"environment\",\n\t\"environments\" : [\n\t\t\"E555a975d628e5926cd82f7e1\"\n\t],\n\t\"users\" : [\n\t\t\"C5157bc0653ca70132b2a88c2;demoUser\"\n\t],\n\t\"meta\" : {\n\t\t\"customLabel\" : \"fancySubTerritory\"\n\t}\n}","language":"http"}]},"results":{"codes":[{"status":201,"language":"json","code":"{\n    \"id\": \"T5bba743ca046af36c0a252f5\",\n    \"ecosystemId\": \"C5157bc0653ca70132b2a88c2\",\n    \"territoryId\": \"T57b26c89a14fa832caa75bd1\",\n    \"itemType\": \"environment\",\n    \"meta\": {\n        \"global\": {\n            \"customLabel\": \"fancySubTerritory\"\n        }\n    },\n    \"createdAt\": \"2018-10-07T21:01:48.442Z\"\n}","name":""},{"status":400,"language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"path\": \"id\",\n            \"message\": \"string 'invalid' does not match pattern '/^(?:T[a-f0-9]{24}$)$/'\"\n        }\n    ]\n}","name":"Territory Invalid"},{"status":400,"name":"Item Type Invalid","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#/itemType\",\n            \"message\": \"value 'invalid' is not defined in enum\"\n        }\n    ]\n}"},{"status":400,"name":"Environment Invalid","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#/environments/0\",\n            \"message\": \"invalid id\"\n        }\n    ]\n}"},{"status":404,"name":"Territory Not Found","language":"text","code":"Territory with id T50baf685a086ab3610a95061 does not exist."},{"status":404,"name":"Environment Not Found","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"body\",\n            \"path\": \"#/environments/0\",\n            \"message\": \"invalid id\"\n        }\n    ]\n}"}]},"settings":"","method":"post","auth":"required","params":[{"_id":"5bba77f8f4234a00039d6100","ref":"","in":"path","required":true,"desc":"The ID of the territory in which the new sub-territory is to be created.","default":"","type":"string","name":"id"},{"_id":"5bba77f8f4234a00039d60ff","ref":"","in":"body","required":true,"desc":"The description of the components of the sub-territory. A sub-territory may only contain items of either type \"territory\" or type \"environment\".","default":"","type":"string","name":"itemType"},{"_id":"5bba77f8f4234a00039d60fe","ref":"","in":"body","required":false,"desc":"The environments to be included within the new sub-territory if `itemType` is set to \"environment\".","default":"","type":"array_string","name":"environments"},{"_id":"5bba77f8f4234a00039d60fd","ref":"","in":"body","required":false,"desc":"The users who have access to the new sub-territory.","default":"","type":"array_string","name":"users"},{"_id":"5bba77f8f4234a00039d60fc","ref":"","in":"body","required":false,"desc":"Any meta data to be included within the new sub-territory.","default":"","type":"object","name":"meta"},{"_id":"5bba77f8f4234a00039d60fb","ref":"","in":"header","required":true,"desc":"The user's authorization token.","default":"","type":"string","name":"authorization"},{"_id":"5bba77f8f4234a00039d60fa","ref":"","in":"header","required":true,"desc":"Specify that the sent data will be a JSON object.","default":"","type":"string","name":"content-type"}],"url":"/api/territories/:id"},"isReference":false,"order":4,"body":"","excerpt":"Create a territory within an existing territory.","slug":"create-a-sub-territory","type":"endpoint","title":"Create a sub-territory."}

postCreate a sub-territory.

Create a territory within an existing territory.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the territory in which the new sub-territory is to be created.

Body Params

itemType:
required
string
The description of the components of the sub-territory. A sub-territory may only contain items of either type "territory" or type "environment".
environments:
array of strings
The environments to be included within the new sub-territory if `itemType` is set to "environment".
users:
array of strings
The users who have access to the new sub-territory.
meta:
object
Any meta data to be included within the new sub-territory.

Headers

authorization:
required
string
The user's authorization token.
content-type:
required
string
Specify that the sent data will be a JSON object.

Examples


Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}