Bynder Metaproperty Options API

{"openapi":"3.1.0","info":{"title":"Metaproperty Options API","version":"1.0.0"},"tags":[{"name":"Metaproperty options operations"}],"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"paths":{"/api/v4/metaproperties/options":{"get":{"summary":"Retrieve metaproperty options by ids","tags":["Metaproperty options operations"],"parameters":[{"name":"ids","in":"query","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000"}}],"responses":{"200":{"description":"A list of metaproperty options","content":{"application/json":{"examples":{"example1":{"value":[{"displayLabel":"Yellow","date":"2017-02-15T14:54:58+00:00","name":"yellow","id":"00000000-0000-0000-0000000000000000","active":1,"label":"Yellow","labels":{"nl_NL":"Geel","en_US":"Yellow"}},{"displayLabel":"Red","date":"2017-02-15T15:50:55+00:00","name":"red","id":"00000000-0000-0000-0000000000000000","active":1,"label":"Red","labels":{"nl_NL":"Rood","en_US":"Red"}}]}}}}},"400":{"description":"Invalid request","content":{"application/json":{"examples":{"noData":{"value":{"message":"No data sent","statuscode":"400"}},"invalidId":{"value":{"message":"Invalid metaproperty option id sent","statuscode":"400"}}}}}}}}},"/api/v4/metaproperties/{id}/options":{"get":{"summary":"Retrieve metaproperty options","tags":["Metaproperty options operations"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"name","in":"query","required":false,"schema":{"type":"string","example":"Amsterdam"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"maximum":1000,"example":250}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1}},{"name":"externalReference","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"displayLabel":{"type":"string","example":"Yellow"},"date":{"type":"string","format":"date-time","example":"2017-02-15T14:54:58+00:00"},"name":{"type":"string","example":"yellow"},"id":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"active":{"type":"integer","example":1},"label":{"type":"string","example":"Yellow"},"labels":{"type":"object","properties":{"nl_NL":{"type":"string","example":"Geel"},"en_US":{"type":"string","example":"Yellow"}}}}}},"examples":{"example1":{"value":[{"displayLabel":"Yellow","date":"2017-02-15T14:54:58+00:00","name":"yellow","id":"00000000-0000-0000-0000000000000000","active":1,"label":"Yellow","labels":{"nl_NL":"Geel","en_US":"Yellow"}},{"displayLabel":"Red","date":"2017-02-15T15:50:55+00:00","name":"red","id":"00000000-0000-0000-0000000000000000","active":1,"label":"Red","labels":{"nl_NL":"Rood","en_US":"Red"}}]}}}}},"400":{"description":"Invalid metaproperty ID","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Invalid metaproperty ID"},"statuscode":{"type":"string","example":"400"}}},"examples":{"invalidId":{"value":{"message":"Invalid metaproperty ID","statuscode":"400"}}}}}}}},"post":{"summary":"Create metaproperty option","description":"Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.","tags":["Metaproperty options operations"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"data":{"type":"string","description":"JSON-serialised string","example":"{\"name\": \"BlueType\", \"externalReference\": \"Reference number 1\", \"label\": \"Blue\", \"labels\": {\"fr_FR\": \"foo\", \"en_US\": \"foo\"}, \"zindex\": 4, \"isSelectable\": true, \"parentId\": \"00000000-0000-0000-0000000000000000\", \"options\": [{\"name\": \"BlueType\", \"label\": \"Blue\", \"labels\": {\"fr_FR\": \"foo\", \"en_US\": \"foo\"}, \"zindex\": 4, \"isSelectable\": true, \"parentId\": \"00000000-0000-0000-0000000000000000\"}]}"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Created"},"statuscode":{"type":"integer","example":201},"id":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Invalid metaproperty ID"},"statuscode":{"type":"string","example":"400"}}},"examples":{"invalidId":{"value":{"message":"Invalid metaproperty ID","statuscode":"400"}},"existingOption":{"value":{"message":"Meta property option with this name already exists","existingUUID":"00000000-0000-0000-0000000000000000","statuscode":"400"}},"nameRequired":{"value":{"message":"Meta property option name is required","statuscode":"400"}},"noData":{"value":{"message":"No data sent","statuscode":"400"}},"invalidJson":{"value":{"message":"Invalid JSON","statuscode":"400"}}}}}},"404":{"description":"Metaproperty not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Metaproperty not found"},"statuscode":{"type":"string","example":"404"}}},"examples":{"notFound":{"value":{"message":"Metaproperty not found","statuscode":"404"}}}}}}}}},"/api/v4/metaproperties/{id}/options/{optionId}":{"post":{"summary":"Modify metaproperty option","description":"Modify a specific metaproperty option.","tags":["Specific metaproperty option operations"],"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"data":{"type":"string","description":"JSON-serialised string","example":"{\"label\": \"Blue\", \"externalReference\": \"Reference number 1\", \"labels\": {\"fr_FR\": \"foo\", \"en_US\": \"foo\"}, \"zindex\": 4, \"isSelectable\": true, \"parentId\": \"00000000-0000-0000-0000000000000000\"}"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Created"},"statuscode":{"type":"integer","example":201}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Editing meta property option name not allowed"},"statuscode":{"type":"string","example":"400"}}},"examples":{"invalidName":{"value":{"message":"Editing meta property option name not allowed","statuscode":"400"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Meta property option not found"},"statuscode":{"type":"string","example":"404"}}},"examples":{"notFound":{"value":{"message":"Meta property option not found","statuscode":"404"}}}}}}}},"delete":{"summary":"Delete metaproperty option","tags":["Specific metaproperty option operations"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"responses":{"204":{"description":"No Content","content":{"application/json":{"example":{"message":"Meta property option deleted successfully","statuscode":"204"}}}},"404":{"description":"Meta property option not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Meta property option not found"},"statuscode":{"type":"string","example":"404"}}},"examples":{"notFound":{"value":{"message":"Meta property option not found","statuscode":"404"}}}}}}}}},"/api/v4/metaproperties/options/dependencies":{"get":{"summary":"Retrieve global option dependencies","description":"Retrieve all metaproperty option dependencies globally.","tags":["Retrieve all metaproperty option dependencies globally"],"responses":{"200":{"description":"A list of global option dependencies.","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}}}},"examples":{"example1":{"value":{"00000000-0000-0000-0000000000000000":{"00000000-0000-0000-0000000000000000":{"00000000-0000-0000-0000000000000000":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000001","00000000-0000-0000-0000000000000002"]}},"00000000-0000-0000-0000000000000001":{"00000000-0000-0000-0000000000000000":{"ungrouped":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000001"]}}}}}}}}}}},"/api/v4/metaproperties/{id}/options/dependencies":{"get":{"summary":"Retrieve metaproperty option dependencies","description":"Retrieve all metaproperty option dependencies for a specific metaproperty.","tags":["Retrieve all metaproperty option dependencies for a metaproperty"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"responses":{"200":{"description":"A list of metaproperty option dependencies.","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}}},"examples":{"example1":{"value":{"00000000-0000-0000-0000000000000000":{"00000000-0000-0000-0000000000000000":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000001","00000000-0000-0000-0000000000000002"],"ungrouped":["00000000-0000-0000-0000000000000000"]}}}}}}},"404":{"description":"Unknown metaproperty","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unknown metaproperty"},"statuscode":{"type":"string","example":"404"}}}}}}}}},"/api/v4/metaproperties/{id}/options/{optionId}/dependencies":{"get":{"summary":"Retrieve specific metaproperty option dependencies","description":"Retrieve options a metaproperty option depends on.","tags":["Retrieve options a metaproperty option depends on"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"includeGroupedResults","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"A list of specific metaproperty option dependencies.","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}}]},"examples":{"example1":{"value":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000001"]},"example2":{"value":{"00000000-0000-0000-0000000000000000":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000001","00000000-0000-0000-0000000000000002"],"ungrouped":["00000000-0000-0000-0000000000000000"]}}}}}},"404":{"description":"Unknown metaproperty or metaproperty option","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unknown metaproperty"},"statuscode":{"type":"string","example":"404"}}}}}}}}},"/api/v4/metaproperties/{id}/options/{optionId}/dependencies/{dependencyId}":{"post":{"summary":"Add a dependency","description":"Manage ungrouped metaproperty option dependencies","tags":["Manage ungrouped metaproperty option dependencies"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"dependencyId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"examples":{"example-201":{"value":{"message":"Created","statuscode":201}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example-unknown-metaproperty":{"value":{"message":"Unknown metaproperty","statuscode":404}},"example-unknown-metaproperty-option":{"value":{"message":"Unknown metaproperty option","statuscode":404}},"example-unknown-dependency-option":{"value":{"message":"Unknown dependency option","statuscode":404}}}}}}}},"delete":{"summary":"Delete a dependency","description":"Delete a dependency from a metaproperty option.","tags":["Manage ungrouped metaproperty option dependencies"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"dependencyId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unknown metaproperty"},"statuscode":{"type":"string","example":"404"}}},"examples":{"example-unknown-metaproperty":{"value":{"message":"Unknown metaproperty","statuscode":404}},"example-unknown-metaproperty-option":{"value":{"message":"Unknown metaproperty option","statuscode":404}},"example-unknown-dependency-option":{"value":{"message":"Unknown dependency option","statuscode":404}}}}}}}}},"/api/v4/metaproperties/{id}/options/{optionId}/dependencies/group":{"post":{"summary":"Create dependency group","description":"Create a dependency group for a metaproperty option.","tags":["Create metaproperty option dependency group"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the metaproperty the (metaproperty) option belongs to.","example":"00000000-0000-0000-0000000000000000"},"optionId":{"type":"string","description":"The id of the (metaproperty) option for which you’d like to create a dependency group.","example":"00000000-0000-0000-0000000000000000"},"data":{"type":"array","items":{"type":"string"},"description":"JSON-serialised list of dependency option ids.","example":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000000"]}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"examples":{"example-201":{"value":{"message":"Created","statuscode":201,"id":"00000000-0000-0000-0000000000000000"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"example-invalid-metaproperty-id":{"value":{"message":"Invalid metaproperty ID","statuscode":"400"}},"example-unknown-metaproperty-option-id":{"value":{"message":"Unknown metaproperty option id","statuscode":"400"}},"example-no-data-sent":{"value":{"message":"No data sent","statuscode":"400"}},"example-data-cannot-be-empty":{"value":{"message":"Data cannot be empty","statuscode":"400"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example-unknown-dependency-option":{"value":{"message":"Unknown dependency option","statuscode":"404"}}}}}}}}},"/api/v4/metaproperties/{id}/options/{optionId}/dependencies/group/{groupId}":{"post":{"summary":"Modify dependency group","description":"Modify a dependency group for a metaproperty option.","tags":["Specific metaproperty option dependency group operations"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the metaproperty the (metaproperty) option belongs to.","example":"00000000-0000-0000-0000000000000000"},"optionId":{"type":"string","description":"The id of the (metaproperty) option the dependency group belongs to.","example":"00000000-0000-0000-0000000000000000"},"groupId":{"type":"string","description":"The id of the dependency group you’d like to modify.","example":"00000000-0000-0000-0000000000000000"},"data":{"type":"array","items":{"type":"string"},"description":"JSON-serialised string of dependency (metaproperty option) ids.","example":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000000"]}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"examples":{"example-201":{"value":{"message":"Created","statuscode":201}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example-unknown-metaproperty-option":{"value":{"message":"Unknown metaproperty option","statuscode":"404"}},"example-unknown-group":{"value":{"message":"Unknown group","statuscode":"404"}}}}}}}}},"/api/v4/metaproperties/{id}/options/{optionId}/dependencies/group/{groupId}/{dependencyId}":{"post":{"summary":"Add a dependency option to a group","description":"Add a dependency option to a specific dependency group for a metaproperty option.","tags":["Manage option dependency in dependency group"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"dependencyId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the metaproperty the (metaproperty) option belongs to.","example":"00000000-0000-0000-0000000000000000"},"optionId":{"type":"string","description":"The id of the (metaproperty) option the dependency group belongs to.","example":"00000000-0000-0000-0000000000000000"},"groupId":{"type":"string","description":"The id of the dependency group you’d like to add a dependency to.","example":"00000000-0000-0000-0000000000000000"},"dependencyId":{"type":"string","description":"The id of the dependency (metaproperty option) you’d like to add to the dependency group.","example":"00000000-0000-0000-0000000000000000"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"examples":{"example-201":{"value":{"message":"Created","statuscode":201}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example-unknown-metaproperty":{"value":{"message":"Unknown metaproperty","statuscode":"404"}},"example-unknown-metaproperty-option":{"value":{"message":"Unknown metaproperty option","statuscode":"404"}},"example-unknown-group":{"value":{"message":"Unknown group","statuscode":"404"}},"example-unknown-dependency-option":{"value":{"message":"Unknown dependency option","statuscode":"404"}}}}}}}},"delete":{"summary":"Remove a dependency option from a group","description":"Remove a dependency option from a specific dependency group for a metaproperty option.","tags":["Manage option dependency in dependency group"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"description":"The id of the metaproperty the (metaproperty) option belongs to."},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"description":"The id of the (metaproperty) option the dependency group belongs to."},{"name":"groupId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"description":"The id of the dependency group you’d like to remove a dependency from."},{"name":"dependencyId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"description":"The id of the dependency (metaproperty option) you’d like to remove from the dependency group."}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unknown metaproperty"},"statuscode":{"type":"string","example":"404"}}},"examples":{"example-unknown-metaproperty":{"value":{"message":"Unknown metaproperty","statuscode":"404"}},"example-unknown-metaproperty-option":{"value":{"message":"Unknown metaproperty option","statuscode":"404"}},"example-unknown-group":{"value":{"message":"Unknown group","statuscode":"404"}},"example-unknown-dependency-option":{"value":{"message":"Unknown dependency option","statuscode":"404"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}}}}}}}