OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
openproject/doc/apiv3/endpoints/string-objects.apib

37 lines
1.4 KiB

# Group String Objects
## Linked Properties
| Link | Description | Type | Constraints | Supported operations |
|:-------------:|-------------------------- | ------------- | ----------- | -------------------- |
| self | This string object | StringObject | not null | READ |
## Local Properties
| Property | Description | Type | Constraints | Supported operations |
|:----------------:| ---------------------------------------------- | -------- | ----------- | -------------------- |
| value | The value of the string | String | | READ |
String objects are a linkable representation of strings. They merely serve the purpose of making links to strings possible,
e.g. to be able to provide `allowedValues` for a string typed property.
## String Object [/api/v3/string_objects?value={value}]
+ Model
+ Body
{
"_links": {
"self": { "href": "/api/v3/string_objects?value=Foo" }
},
"_type": "StringObject",
"value": "Foo"
}
## View String Object [GET]
+ Parameters
+ value (required, string, `Foo`) ... The string value being resolved
+ Response 200 (application/hal+json)
[String Object][]