Request Form

APIs for managing request forms

Search request forms

get

Search request forms in the marketplace using the provided filters

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

offsetnumberOptionalDefault: 0

limitnumber · min: 1OptionalDefault: 10

sortOrderstring · enumOptionalDefault: ascPossible values:

sortBystring · enumOptionalDefault: namePossible values:

nameFilterstringOptional

Filter results by request form name

Default: ""

exactMatchbooleanOptional

Whether the filter should be an exact match

Default: false

Responses

200Success

application/json

get/api/request-form

GET /marketplace/api/request-form HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "fields": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "DROPDOWN",
          "label": "text",
          "required": true,
          "options": [
            {
              "value": "text"
            }
          ]
        }
      ],
      "policy": {
        "version": "text",
        "rules": [
          {
            "conditions": {
              "all": []
            },
            "event": {
              "type": "approve",
              "params": {
                "comment": "text",
                "duration": 1,
                "durationUnit": "HOURS"
              }
            }
          }
        ],
        "defaultEvent": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      },
      "dataUseAgreements": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "body": "text"
        }
      ],
      "createdBy": {
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedBy": {
        "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "version": "text",
      "associatedDomains": [
        "4d004a3a-4568-4c1d-822e-30958ef898dc"
      ]
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

Create request form

post

Create a request form

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestringRequired

idstring · uuidOptional

dataUseAgreementIdsstring · uuid[]Optional

Responses

201Success

application/json

idstring · uuidRequired

namestringRequired

createdAtone ofRequired

string · date-timeOptional

updatedAtone ofRequired

string · date-timeOptional

versionstring · cuidRequired

The current version of the request form

409

Request form with name already exists.

post/api/request-form

POST /marketplace/api/request-form HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 510

{
  "name": "text",
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "dataUseAgreementIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "dataUseAgreements": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "body": "text"
    }
  ],
  "createdBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "version": "text"
}

Get request form by ID

get

Get request form by ID

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200Success

application/json

idstring · uuidRequired

namestringRequired

createdAtone ofRequired

string · date-timeOptional

updatedAtone ofRequired

string · date-timeOptional

versionstring · cuidRequired

The current version of the request form

get/api/request-form/{id}

GET /marketplace/api/request-form/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "dataUseAgreements": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "body": "text"
    }
  ],
  "createdBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "version": "text"
}

Update request form by ID

put

Update a request form

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

namestringOptional

idstring · uuidOptional

dataUseAgreementIdsstring · uuid[]Optional

Responses

201Success

application/json

idstring · uuidRequired

namestringRequired

createdAtone ofRequired

string · date-timeOptional

updatedAtone ofRequired

string · date-timeOptional

versionstring · cuidRequired

The current version of the request form

put/api/request-form/{id}

PUT /marketplace/api/request-form/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 510

{
  "name": "text",
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "dataUseAgreementIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

201Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "dataUseAgreements": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "body": "text"
    }
  ],
  "createdBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "version": "text"
}

Delete request form by ID

delete

Delete a request form

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

204Success

No content

delete/api/request-form/{id}

DELETE /marketplace/api/request-form/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204Success

No content

Get request form by version

get

Get request form by its version

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

versionstringRequired

Responses

200Success

application/json

idstring · uuidRequired

namestringRequired

createdAtone ofRequired

string · date-timeOptional

updatedAtone ofRequired

string · date-timeOptional

versionstring · cuidRequired

The current version of the request form

get/api/request-form/version/{version}

GET /marketplace/api/request-form/version/{version} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "DROPDOWN",
      "label": "text",
      "required": true,
      "options": [
        {
          "value": "text"
        }
      ]
    }
  ],
  "policy": {
    "version": "text",
    "rules": [
      {
        "conditions": {
          "all": []
        },
        "event": {
          "type": "approve",
          "params": {
            "comment": "text",
            "duration": 1,
            "durationUnit": "HOURS"
          }
        }
      }
    ],
    "defaultEvent": {
      "type": "approve",
      "params": {
        "comment": "text",
        "duration": 1,
        "durationUnit": "HOURS"
      }
    }
  },
  "dataUseAgreements": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "body": "text"
    }
  ],
  "createdBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedBy": {
    "globalUserId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  },
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "version": "text"
}

Get data products assigned to the request form

get

Get the data products assigned to the request form

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200Success

application/json

The data products linked to the request form

idone ofRequired

string · cuidOptional

string · uuidOptional

namestring · min: 1 · max: 255Required

Data product name

Pattern: ^[\p{L}\p{M}\p{N})(\-_/\\\s]*$

get/api/request-form/{id}/data-products

GET /marketplace/api/request-form/{id}/data-products HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "id": "text",
    "name": "text",
    "requestTypes": [
      "DATA_ACCESS"
    ]
  }
]

Get assets assigned to the request form

get

Get the assets assigned to the request form

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200Success

application/json

The assets linked to the request form

idone ofRequired

string · cuidOptional

string · uuidOptional

namestring · min: 1Required

Asset name

typestring · enumRequiredPossible values:

requestTypestring · enumRequiredPossible values:

get/api/request-form/{id}/assets

GET /marketplace/api/request-form/{id}/assets HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "id": "text",
    "name": "text",
    "type": "DATA_PRODUCT",
    "requestType": "DATA_ACCESS"
  }
]

PreviousAccess Request

NextData Use Agreement

Last updated 2 months ago

Was this helpful?