Adding entity to OIP API
1 min
POST
https://oip-api-dev.fasst.tech/api/core/entities
Header Parameters
- AuthorizationstringrequiredDescription
Body Parameters
- requestrequests.EntityRequestrequiredDescription
- coreVersionstringrequiredExample
- descriptionstringrequiredExample
- isArraybooleanrequiredExample
- isDeprecatedbooleanrequiredExample
- methodsstring[]requiredExample
[ "get", "findAll" ]
- namestringrequiredExample
- propertiesrequests.PropertyRequest[]
- deprecatedMessagestringExample
- descriptionstringrequiredExample
- isDeprecatedbooleanrequired
- isReadonlybooleanrequired
- namestringrequiredExample
- typerequests.TypeRequestrequired
- enumValuesstring[]Example
[ "enum1", " enum2" ]
- isArraybooleanrequired
- namestringrequiredExample
- validatorrequests.ValidatorRequest
- exactLengthintegerrequiredExample
- maxLengthintegerrequiredExample
- minLengthintegerrequiredExample
- typestring[]requiredExample
[ "mail", " postal" ]
- relationsrequests.RelationRequest[]
- propertyNamestringrequiredExample
- propertyTypestringrequiredExample
Responses
200
- responses.EntityResponseDescription
- coreVersionstringExample
- descriptionstringExample
- isArraybooleanExample
- isDeprecatedbooleanExample
- methodsstring[]Example
[ "get", "findAll" ]
- namestringExample
- propertiesresponses.PropertyResponse[]
- deprecatedMessagestringExample
- descriptionstringExample
- isDeprecatedboolean
- isReadonlyboolean
- namestringExample
- typeresponses.TypeResponse
- enumValuesstring[]Example
[ "enum1", " enum2" ]
- isArraybooleanrequired
- namestringrequiredExample
- validatorresponses.ValidatorResponse
- exactLengthintegerrequiredExample
- maxLengthintegerrequiredExample
- minLengthintegerrequiredExample
- typestring[]requiredExample
[ "mail", " postal" ]
- relationsresponses.RelationResponse[]
- isArraybooleanrequired
- propertyNamestringrequiredExample
- propertyTypestringrequiredExample
curl
curl --location 'https://oip-api-dev.fasst.tech/api/core/entities' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"request":{"coreVersion":"string","description":"string","isArray":false,"isDeprecated":false,"methods":[],"name":"string"}}'javascript
var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
var raw = JSON.stringify({
"request": {
"coreVersion": "string",
"description": "string",
"isArray": false,
"isDeprecated": false,
"methods": [],
"name": "string"
}
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://oip-api-dev.fasst.tech/api/core/entities", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://oip-api-dev.fasst.tech/api/core/entities")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
"request": {
"coreVersion": "string",
"description": "string",
"isArray": false,
"isDeprecated": false,
"methods": [],
"name": "string"
}
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://oip-api-dev.fasst.tech/api/core/entities"
payload = json.dumps({
"request": {
"coreVersion": "string",
"description": "string",
"isArray": False,
"isDeprecated": False,
"methods": [],
"name": "string"
}
})
headers = {
'Accept': 'application/json',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// OK
{
"coreVersion": "1.0.0",
"description": "Structure du projet",
"isArray": true,
"isDeprecated": true,
"methods": [
""
],
"name": "Project",
"properties": [
{
"deprecatedMessage": "message",
"description": "description",
"isDeprecated": false,
"isReadonly": false,
"name": "name",
"type": {
"enumValues": [
""
],
"isArray": false,
"name": "name"
},
"validator": {
"exactLength": 4,
"maxLength": 4,
"minLength": 4,
"type": [
""
]
}
}
],
"relations": [
{
"isArray": false,
"propertyName": "name",
"propertyType": "string"
}
]
}