Using the API to Fetch Project and Entity
- Ashrafuzzaman Purno
Owned by Ashrafuzzaman Purno
- 1 Terminologies
- 2 Template/Entity APIs
- 2.1 List Projects
- 2.1.1 Parameters
- 2.1.2 Request URL
- 2.1.3 Example Response
- 2.2 Get Project
- 2.2.1 Request URL
- 2.2.2 Example Response
- 2.3 Get Project Entity by Entity Name
- 2.3.1 Parameters
- 2.3.2 Request URL
- 2.3.3 Example Response
- 2.4 List Member Entities
- 2.4.1 Request URL
- 2.4.2 Example Response
- 2.5 List Owner Entities
- 2.5.1 Request URL
- 2.5.2 Example Response
- 2.1 List Projects
Terminologies
Organization | Archive Institute |
Project | Database Schema |
Template | Schema DDL |
Entity | Database Table |
Field | Table Column |
Entity Structure | PK -> Fk relations |
Content | Archive unit metadata |
Digital file | Files attached with archive units |
AMID | Unique identifier for every archive unit |
Template/Entity APIs
List Projects
/api/projectParameters
Name | Type | Default | Description |
|---|---|---|---|
lite | Boolean | false | Only get id and name |
onlyAdmin | Boolean | false | Only projects with admin rights |
initializedArchives | Boolean | null | Only get projects with/without initialized archives, if null ignores archive state |
Request URL
http://localhost/gui-server/api/project?lite=false&onlyAdmin=false&initializedArchives=trueExample Response
[
{
"id": "kurs",
"name": "KURS",
"description": "",
"templateId": "bb4bd713-307e-4c2d-aa0e-872a1d4bf57e",
"templateName": "ISAD(G)_Asta5_template-kurs",
"organizationId": "9c8009ac-d5b2-43f5-ba82-d39bba61941f",
"organizationName": "KURS",
"organizationCode": "KURS",
"archiveInitialized": true,
"projectStandard": "ISADG",
"systemTemplates": null
}
{
"id": "kbenh",
"name": "København",
"description": "",
"templateId": "d2ada7a6-0859-4000-a929-d98399c6f6ce",
"templateName": "Starbas-kbenh-kbenh",
"organizationId": "eb2159a2-d3c5-428c-8d7a-53686a58adbb",
"organizationName": "STARBAS",
"organizationCode": "STARBAS",
"archiveInitialized": true,
"projectStandard": "STARBAS",
"systemTemplates": null
}
]Get Project
Request URL
Example Response
Get Project Entity by Entity Name
Parameters
Name | Type | Default | Description |
|---|---|---|---|
name | String | Not default must be provided | Entity name ignoring case |
getFields | Boolean | true | Should include entity fields or not |