> For the complete documentation index, see [llms.txt](https://engineering-ing-inf-rd.gitbook.io/true-connector/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://engineering-ing-inf-rd.gitbook.io/true-connector/contract-negotiation/contract_request_message.md).
# Contract Request Message
Contract Request Message is initial message sent in Contract Negotiation flow. It can contain requestedElement, if we know what artifact we are requesting, or without it, if we need to get whole self description document, and then analyze it and get element we are looking for.
Multipart form - Contract Request Message
```
curl --location -k --request POST 'https://localhost:8184/proxy' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic aWRzVXNlcjpwYXNzd29yZA==' \
--data-raw '{
"multipart": "form",
"Forward-To": "https://ecc-provider:8889/data",
"messageType": "ContractRequestMessage",
"requestedElement": "http://w3id.org/engrd/connector/artifact/1",
"payload" : {
"@context": {
"ids": "https://w3id.org/idsa/core/",
"idsc": "https://w3id.org/idsa/code/"
},
"@type": "ids:ContractRequest",
"@id": "{{contract_id}}",
"ids:permission": [
{{contract_permission}}
],
"ids:provider": {
"@id": "{{contract_provider}}"
},
"ids:obligation": [],
"ids:prohibition": [],
"ids:consumer": {
"@id": "http://w3id.org/engrd/connector/consumer"
}
}
}'
```
For payload part placeholders, Postman collection will preset required fields from previous request.
Contract Request Payload part
```
{
"@context": {
"ids": "https://w3id.org/idsa/core/",
"idsc": "https://w3id.org/idsa/code/"
},
"@type": "ids:ContractRequest",
"@id": "https://w3id.org/idsa/autogen/contractRequest/46863e9c-e7ce-4041-959c-11b317a10c5c",
"ids:permission": [
{
"@type": "ids:Permission",
"@id": "https://w3id.org/idsa/autogen/permission/57c1728b-788d-4b80-ae1d-02a7d46eb1a0",
"ids:target": {
"@id": "http://w3id.org/engrd/connector/artifact/1"
},
"ids:assignee": [],
"ids:assigner": [],
"ids:action": [
{
"@id": "https://w3id.org/idsa/code/USE"
}
],
"ids:preDuty": [],
"ids:postDuty": [],
"ids:constraint": [
{
"@type": "ids:Constraint",
"@id": "https://w3id.org/idsa/autogen/constraint/07f7dd8b-0b47-46e9-8d25-7205ea243de9",
"ids:leftOperand": {
"@id": "https://w3id.org/idsa/code/POLICY_EVALUATION_TIME"
},
"ids:operator": {
"@id": "https://w3id.org/idsa/code/AFTER"
},
"ids:rightOperand": {
"@value": "2022-06-20T09:43:49Z",
"@type": "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
},
"ids:pipEndpoint": {
"@id": "http://pip.endpoint.after"
}
},
{
"@type": "ids:Constraint",
"@id": "https://w3id.org/idsa/autogen/constraint/5832a389-9af1-4e2f-9ab4-038ac5db0091",
"ids:leftOperand": {
"@id": "https://w3id.org/idsa/code/POLICY_EVALUATION_TIME"
},
"ids:operator": {
"@id": "https://w3id.org/idsa/code/BEFORE"
},
"ids:rightOperand": {
"@value": "2022-07-27T09:43:49Z",
"@type": "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
},
"ids:pipEndpoint": {
"@id": "http://pip.endpoint.before"
}
}
],
"ids:description": [],
"ids:title": []
}
],
"ids:provider": {
"@id": "http://w3id.org/engrd/connector/provider"
},
"ids:obligation": [],
"ids:prohibition": [],
"ids:consumer": {
"@id": "http://w3id.org/engrd/connector/consumer"
}
}
```
If everything goes well, you will get response with "ids:ContractAgreement", as shown in example response.
Contract Request Message - Response example
```
{
"@context": {
"ids": "https://w3id.org/idsa/core/",
"idsc": "https://w3id.org/idsa/code/"
},
"@type": "ids:ContractAgreement",
"@id": "https://w3id.org/idsa/autogen/contractAgreement/1150fc17-dd70-41a9-9f5a-7e26ce082018",
"ids:contractStart": {
"@value": "2023-06-27T09:51:29.638Z",
"@type": "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
},
"ids:contractDate": {
"@value": "2023-06-27T09:51:29.620Z",
"@type": "http://www.w3.org/2001/XMLSchema#dateTimeStamp"
},
"ids:consumer": {
"@id": "http://w3id.org/engrd/connector/consumer"
},
"ids:provider": {
"@id": "http://w3id.org/engrd/connector/provider"
},
"ids:permission": [
{
"@type": "ids:Permission",
"@id": "https://w3id.org/idsa/autogen/permission/f04e78e7-3808-404d-8436-d7f7c264f307",
"ids:action": [
{
"@id": "https://w3id.org/idsa/code/USE"
}
],
"ids:title": [
{
"@value": "Example Usage Policy",
"@type": "http://www.w3.org/2001/XMLSchema#string"
}
],
"ids:description": [
{
"@value": "provide-access",
"@type": "http://www.w3.org/2001/XMLSchema#string"
}
],
"ids:target": {
"@id": "http://w3id.org/engrd/connector/artifact/1"
}
}
]
}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://engineering-ing-inf-rd.gitbook.io/true-connector/contract-negotiation/contract_request_message.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.