openapi: 3.0.1 info: title: elma-rest-api description: REST API version: 3.24.0 servers: - url: https://test-smp.difi.no tags: [] paths: /rest/api/accessPoints: get: tags: - rest summary: Find access points description: Find access points operationId: accessPoints/find parameters: - name: page in: query description: Page you want to retrieve. First page is page 0 required: false schema: type: string - name: size in: query description: Size of the page you want to retrieve. required: false schema: type: string - name: sort in: query description: "Properties that should be sorted by in the format property,property(,ASC|DESC).\ \ Default sort direction is ascending. Use multiple sort parameters if you\ \ want to switch directions, e.g. ?sort=firstname&sort=lastname,asc." required: false schema: type: string responses: "200": description: "200" content: application/vnd.no.digdir.elma.accesspoints.find.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/AccessPointPage' examples: accessPoints/find: value: |- { "content" : [ { "identifier" : "1c0c645b-ca13-4bdd-8ad0-dfc518d78fe0", "title" : "The Great Access Point", "provider" : { "identifier" : "d51718f7-f889-4d75-86a3-bc7475e23347", "title" : "The Hitech Company", "contact" : { "name" : "Mr. Robot", "email" : "robot@hitech.com", "phoneNumber" : "12345678" } }, "endpoints" : [ { "transportProfile" : { "title" : "Peppol AS2 Profile 2.0", "value" : "busdox-transport-as2-ver2p0", "certificateTypes" : [ "Peppol Production" ] }, "url" : "https://www.example.com/oxalis/as4" } ] }, { "identifier" : "6a450eaf-7023-419b-9e69-b21d2775cade", "title" : "The Shiny Access Point", "provider" : { "identifier" : "d51718f7-f889-4d75-86a3-bc7475e23347", "title" : "The Hitech Company", "contact" : { "name" : "Mr. Robot", "email" : "robot@hitech.com", "phoneNumber" : "12345678" } }, "endpoints" : [ { "transportProfile" : { "title" : "Peppol AS2 Profile 2.0", "value" : "busdox-transport-as2-ver2p0", "certificateTypes" : [ "Peppol Production" ] }, "url" : "https://www.example.com/shiny/as4" } ] } ], "pageable" : { "sort" : { "sorted" : false, "unsorted" : true, "empty" : true }, "pageNumber" : 0, "pageSize" : 30, "offset" : 0, "paged" : true, "unpaged" : false }, "last" : true, "totalPages" : 1, "totalElements" : 2, "sort" : { "sorted" : false, "unsorted" : true, "empty" : true }, "first" : true, "number" : 0, "numberOfElements" : 2, "size" : 30, "empty" : false } security: - basic: [] /rest/api/document-types: get: tags: - rest summary: Find document types (Paged) description: Find document types (Paged) operationId: document-types/find parameters: - name: page in: query description: Page you want to retrieve. First page is page 0 required: false schema: type: string - name: size in: query description: Size of the page you want to retrieve. required: false schema: type: string - name: sort in: query description: "Properties that should be sorted by in the format property,property(,ASC|DESC).\ \ Default sort direction is ascending. Use multiple sort parameters if you\ \ want to switch directions, e.g. ?sort=firstname&sort=lastname,asc." required: false schema: type: string responses: "200": description: "200" content: application/vnd.no.digdir.elma.document-types.find.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/DocumentTypePage' examples: document-types/find: value: |- { "content" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding", "title" : "Arkivmelding", "visible" : true, "processes" : [ { "identifier" : "705d8c8d-8ff1-4c21-a444-3e74815956cd", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:no:difi:profile:arkivmelding:administrasjon:ver1.0", "title" : "Arkivmelding_Administrasjon", "visible" : true, "restricted" : false } ] }, { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something", "visible" : true, "processes" : [ ] } ], "pageable" : { "sort" : { "sorted" : false, "unsorted" : true, "empty" : true }, "pageNumber" : 0, "pageSize" : 30, "offset" : 0, "paged" : true, "unpaged" : false }, "last" : true, "totalPages" : 1, "totalElements" : 2, "sort" : { "sorted" : false, "unsorted" : true, "empty" : true }, "first" : true, "number" : 0, "numberOfElements" : 2, "size" : 30, "empty" : false } security: - basic: [] post: tags: - rest summary: Add document type description: Add document type operationId: document-types/add requestBody: content: application/vnd.no.digdir.elma.document-types.add.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/DocumentTypeForm' examples: document-types/add: value: |- { "title" : "Arkivmelding", "qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding", "visible" : true, "processes" : [ { "identifier" : "705d8c8d-8ff1-4c21-a444-3e74815956cd" } ] } responses: "201": description: "201" content: application/vnd.no.digdir.elma.document-types.add.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/DocumentType' examples: document-types/add: value: |- { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding", "title" : "Arkivmelding", "visible" : true, "processes" : [ { "identifier" : "705d8c8d-8ff1-4c21-a444-3e74815956cd", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:no:difi:profile:arkivmelding:administrasjon:ver1.0", "title" : "Arkivmelding_Administrasjon", "visible" : true, "restricted" : false } ] } security: - basic: [] /rest/api/participants: get: tags: - rest summary: Find participants (List) description: Find participants (List) operationId: participants/ parameters: - name: query in: query description: Search for name and organization number. required: false schema: type: string - name: processes in: query description: "Set this to true if you want the response to include participant\ \ processes. Default: false" required: false schema: type: string - name: page in: query description: Page you want to retrieve. First page is page 0 required: false schema: type: string - name: size in: query description: Size of the page you want to retrieve. required: false schema: type: string - name: sort in: query description: "Properties that should be sorted by in the format property,property(,ASC|DESC).\ \ Default sort direction is ascending. Use multiple sort parameters if you\ \ want to switch directions, e.g. ?sort=firstname&sort=lastname,asc." required: false schema: type: string responses: "200": description: "200" content: application/vnd.no.digdir.elma.participants.stream.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/ParticipantList' examples: participants/stream: value: |- [ { "identifier" : "0eeddc80-3baa-44eb-98c2-90168ca09e91", "qualifiedIdentifier" : "iso6523-actorid-upis::0192:987654321", "icd" : "0192", "organizationIdentifier" : "987654321", "name" : "Snow Factory AS", "registrationDate" : "2020-08-26", "lastModificationDate" : "2020-09-02", "contact" : { "name" : "Snømannen Kalle", "email" : "kalle@snowfactory.no", "phoneNumber" : "111111111" }, "provider" : { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa", "title" : "The Big Bank" } }, { "identifier" : "a74363a2-1038-4a3f-a599-97ff860787e0", "qualifiedIdentifier" : "iso6523-actorid-upis::0192:222222222", "icd" : "0192", "organizationIdentifier" : "222222222", "name" : "Doofenshmirtz Evil Inc", "registrationDate" : "2001-05-12", "lastModificationDate" : "2020-09-01", "contact" : { "name" : "Heinz Doofenshmirtz", "email" : "heinz.doofemshmirtz@evil.inc", "phoneNumber" : "22222222" }, "provider" : { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa", "title" : "The Big Bank" } } ] application/vnd.no.digdir.elma.participants.find.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/ParticipantPage' examples: participants/find: value: |- { "content" : [ { "identifier" : "0eeddc80-3baa-44eb-98c2-90168ca09e91", "qualifiedIdentifier" : "iso6523-actorid-upis::0192:987654321", "icd" : "0192", "organizationIdentifier" : "987654321", "name" : "Snow Factory AS", "registrationDate" : "2020-08-26", "lastModificationDate" : "2020-09-02", "contact" : { "name" : "Snømannen Kalle", "email" : "kalle@snowfactory.no", "phoneNumber" : "111111111" }, "provider" : { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa", "title" : "The Big Bank" } }, { "identifier" : "a74363a2-1038-4a3f-a599-97ff860787e0", "qualifiedIdentifier" : "iso6523-actorid-upis::0192:222222222", "icd" : "0192", "organizationIdentifier" : "222222222", "name" : "Doofenshmirtz Evil Inc", "registrationDate" : "2001-05-12", "lastModificationDate" : "2020-09-01", "contact" : { "name" : "Heinz Doofenshmirtz", "email" : "heinz.doofemshmirtz@evil.inc", "phoneNumber" : "22222222" }, "provider" : { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa", "title" : "The Big Bank" } } ], "pageable" : { "sort" : { "sorted" : false, "unsorted" : true, "empty" : true }, "pageNumber" : 0, "pageSize" : 30, "offset" : 0, "paged" : true, "unpaged" : false }, "last" : true, "totalPages" : 1, "totalElements" : 2, "sort" : { "sorted" : false, "unsorted" : true, "empty" : true }, "first" : true, "number" : 0, "numberOfElements" : 2, "size" : 30, "empty" : false } security: - basic: [] post: tags: - rest summary: Add participant description: Add participant operationId: participants/add requestBody: content: application/vnd.no.digdir.elma.participants.add.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/AddParticipantForm' examples: participants/add: value: |- { "icd" : "0192", "organizationIdentifier" : "222222222", "name" : "Doofenshmirtz Evil Inc", "processes" : [ { "identifier" : "adf9c140-995e-4be6-a1be-a09add595423" } ], "contact" : { "name" : "Heinz Doofenshmirtz", "email" : "heinz.doofemshmirtz@evil.inc", "phoneNumber" : "22222222" } } responses: "201": description: "201" content: application/vnd.no.digdir.elma.participants.add.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/Participant' examples: participants/add: value: |- { "identifier" : "a74363a2-1038-4a3f-a599-97ff860787e0", "qualifiedIdentifier" : "iso6523-actorid-upis::0192:222222222", "icd" : "0192", "organizationIdentifier" : "222222222", "name" : "Doofenshmirtz Evil Inc", "registrationDate" : "2001-05-12", "lastModificationDate" : "2020-09-01", "contact" : { "name" : "Heinz Doofenshmirtz", "email" : "heinz.doofemshmirtz@evil.inc", "phoneNumber" : "22222222" }, "processes" : [ { "identifier" : "adf9c140-995e-4be6-a1be-a09add595423", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_3_0_BILLING_01_UBL", "alias" : "PEPPOL BIS Billing 3.0 (01, UBL)", "restricted" : false, "capabilities" : [ { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa", "title" : "peppolbis_order" } ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something" } ], "dependencies" : [ { "identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep", "title" : "TEST DEPENDENCY", "restricted" : false } ], "requiredICDs" : [ "0192" ] } ] } security: - basic: [] /rest/api/processes: get: tags: - rest summary: Find processes (List) description: Find processes (List) operationId: processes/ parameters: - name: page in: query description: Page you want to retrieve. First page is page 0 required: false schema: type: string - name: size in: query description: Size of the page you want to retrieve. required: false schema: type: string - name: sort in: query description: "Properties that should be sorted by in the format property,property(,ASC|DESC).\ \ Default sort direction is ascending. Use multiple sort parameters if you\ \ want to switch directions, e.g. ?sort=firstname&sort=lastname,asc." required: false schema: type: string responses: "200": description: "200" content: application/vnd.no.digdir.elma.processes.stream.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/ProcessList' examples: processes/stream: value: |- [ { "identifier" : "adf9c140-995e-4be6-a1be-a09add595423", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_3_0_BILLING_01_UBL", "alias" : "PEPPOL BIS Billing 3.0 (01, UBL)", "restricted" : false, "visible" : true, "capabilities" : [ { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa", "title" : "peppolbis_order" } ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something", "visible" : true } ], "dependencies" : [ { "identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep", "title" : "TEST DEPENDENCY", "restricted" : false, "visible" : true } ], "requiredICDs" : [ "0192" ] }, { "identifier" : "705d8c8d-8ff1-4c21-a444-3e7481595696", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:www.cenbii.eu:profile:bii28:ver2.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_28A_2.0", "alias" : "PEPPOL BIS Ordering 2.0 (Profile 28A)", "restricted" : false, "visible" : true, "capabilities" : [ ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something", "visible" : true } ], "dependencies" : [ ], "requiredICDs" : [ "9908" ] } ] application/vnd.no.digdir.elma.processes.find.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/ProcessPage' examples: processes/find: value: |- { "content" : [ { "identifier" : "adf9c140-995e-4be6-a1be-a09add595423", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_3_0_BILLING_01_UBL", "alias" : "PEPPOL BIS Billing 3.0 (01, UBL)", "restricted" : false, "visible" : true, "capabilities" : [ { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa", "title" : "peppolbis_order" } ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something", "visible" : true } ], "dependencies" : [ { "identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep", "title" : "TEST DEPENDENCY", "restricted" : false, "visible" : true } ], "requiredICDs" : [ "0192" ] }, { "identifier" : "705d8c8d-8ff1-4c21-a444-3e7481595696", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:www.cenbii.eu:profile:bii28:ver2.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_28A_2.0", "alias" : "PEPPOL BIS Ordering 2.0 (Profile 28A)", "restricted" : false, "visible" : true, "capabilities" : [ ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something", "visible" : true } ], "dependencies" : [ ], "requiredICDs" : [ "9908" ] } ], "pageable" : { "sort" : { "sorted" : false, "unsorted" : true, "empty" : true }, "pageNumber" : 0, "pageSize" : 30, "offset" : 0, "paged" : true, "unpaged" : false }, "last" : true, "totalPages" : 1, "totalElements" : 2, "sort" : { "sorted" : false, "unsorted" : true, "empty" : true }, "first" : true, "number" : 0, "numberOfElements" : 2, "size" : 30, "empty" : false } security: - basic: [] post: tags: - rest summary: Add process description: Add process operationId: processes/add requestBody: content: application/vnd.no.digdir.elma.processes.add.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/ProcessForm' examples: processes/add: value: |- { "domain" : "Post-Award", "title" : "PEPPOLBIS_3_0_BILLING_01_UBL", "alias" : "PEPPOL BIS Billing 3.0 (01, UBL)", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0", "restricted" : false, "visible" : true, "capabilities" : [ { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa" } ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7" } ], "dependencies" : [ { "identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd" } ], "requiredICDs" : [ "0192" ] } responses: "201": description: "201" content: application/vnd.no.digdir.elma.processes.add.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/Process' examples: processes/add: value: |- { "identifier" : "adf9c140-995e-4be6-a1be-a09add595423", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_3_0_BILLING_01_UBL", "alias" : "PEPPOL BIS Billing 3.0 (01, UBL)", "restricted" : false, "visible" : true, "capabilities" : [ { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa", "title" : "peppolbis_order" } ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something", "visible" : true } ], "dependencies" : [ { "identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep", "title" : "TEST DEPENDENCY", "restricted" : false, "visible" : true } ], "requiredICDs" : [ "0192" ] } security: - basic: [] /rest/api/accessPoints/{accessPoint}: get: tags: - rest summary: Get access point description: Get access point operationId: accessPoints/get parameters: - name: accessPoint in: path description: An access point identifier that is an UUID. required: true schema: type: string responses: "200": description: "200" content: application/vnd.no.digdir.elma.accesspoints.get.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/AccessPoint' examples: accessPoints/get: value: |- { "identifier" : "1c0c645b-ca13-4bdd-8ad0-dfc518d78fe0", "title" : "The Great Access Point", "provider" : { "identifier" : "d51718f7-f889-4d75-86a3-bc7475e23347", "title" : "The Hitech Company", "contact" : { "name" : "Mr. Robot", "email" : "robot@hitech.com", "phoneNumber" : "12345678" } }, "endpoints" : [ { "transportProfile" : { "title" : "Peppol AS2 Profile 2.0", "value" : "busdox-transport-as2-ver2p0", "certificateTypes" : [ "Peppol Production" ] }, "url" : "https://www.example.com/oxalis/as4" } ] } security: - basic: [] /rest/api/document-types/{identifier}: get: tags: - rest summary: Get document type description: Get document type operationId: document-types/get parameters: - name: identifier in: path description: A process identifier that is an UUID. required: true schema: type: string responses: "200": description: "200" content: application/vnd.no.digdir.elma.document-types.get.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/DocumentType' examples: document-types/get: value: |- { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding", "title" : "Arkivmelding", "visible" : true, "processes" : [ { "identifier" : "705d8c8d-8ff1-4c21-a444-3e74815956cd", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:no:difi:profile:arkivmelding:administrasjon:ver1.0", "title" : "Arkivmelding_Administrasjon", "visible" : true, "restricted" : false } ] } security: - basic: [] put: tags: - rest summary: Update document type description: Update document type operationId: document-types/update parameters: - name: identifier in: path description: A process identifier that is an UUID. required: true schema: type: string requestBody: content: application/vnd.no.digdir.elma.document-types.update.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/DocumentTypeForm' examples: document-types/update: value: |- { "title" : "Arkivmelding", "qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding", "visible" : true, "processes" : [ { "identifier" : "705d8c8d-8ff1-4c21-a444-3e74815956cd" } ] } responses: "200": description: "200" content: application/vnd.no.digdir.elma.document-types.update.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/DocumentType' examples: document-types/update: value: |- { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:no:difi:arkivmelding:xsd::arkivmelding", "title" : "Arkivmelding", "visible" : true, "processes" : [ { "identifier" : "705d8c8d-8ff1-4c21-a444-3e74815956cd", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:no:difi:profile:arkivmelding:administrasjon:ver1.0", "title" : "Arkivmelding_Administrasjon", "visible" : true, "restricted" : false } ] } security: - basic: [] delete: tags: - rest summary: Delete document type description: Delete document type operationId: document-types/delete parameters: - name: identifier in: path description: A process identifier that is an UUID. required: true schema: type: string responses: "204": description: "204" security: - basic: [] /rest/api/participants/{identifier}: delete: tags: - rest summary: Delete participant by identifier description: Delete participant by identifier operationId: participants/delete-by-identifier parameters: - name: identifier in: path description: A participant identifier that is an UUID. required: true schema: type: string responses: "204": description: "204" security: - basic: [] /rest/api/participants/{qualifiedIdentifier}: get: tags: - rest summary: Get participant description: Get participant operationId: participants/get parameters: - name: qualifiedIdentifier in: path description: "An identifier that is qualified by a schema. It consists of\ \ :: : ." required: true schema: type: string responses: "200": description: "200" content: application/vnd.no.digdir.elma.participants.get.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/Participant' examples: participants/get: value: |- { "identifier" : "a74363a2-1038-4a3f-a599-97ff860787e0", "qualifiedIdentifier" : "iso6523-actorid-upis::0192:222222222", "icd" : "0192", "organizationIdentifier" : "222222222", "name" : "Doofenshmirtz Evil Inc", "registrationDate" : "2001-05-12", "lastModificationDate" : "2020-09-01", "contact" : { "name" : "Heinz Doofenshmirtz", "email" : "heinz.doofemshmirtz@evil.inc", "phoneNumber" : "22222222" }, "processes" : [ { "identifier" : "adf9c140-995e-4be6-a1be-a09add595423", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_3_0_BILLING_01_UBL", "alias" : "PEPPOL BIS Billing 3.0 (01, UBL)", "restricted" : false, "capabilities" : [ { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa", "title" : "peppolbis_order" } ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something" } ], "dependencies" : [ { "identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep", "title" : "TEST DEPENDENCY", "restricted" : false } ], "requiredICDs" : [ "0192" ] }, { "identifier" : "705d8c8d-8ff1-4c21-a444-3e7481595696", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:www.cenbii.eu:profile:bii28:ver2.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_28A_2.0", "alias" : "PEPPOL BIS Ordering 2.0 (Profile 28A)", "restricted" : false, "capabilities" : [ ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something" } ], "dependencies" : [ ], "requiredICDs" : [ "9908" ] } ] } security: - basic: [] put: tags: - rest summary: Update participant description: Update participant operationId: participants/update parameters: - name: qualifiedIdentifier in: path description: "An identifier that is qualified by a schema. It consists of\ \ :: : ." required: true schema: type: string requestBody: content: application/vnd.no.digdir.elma.participants.update.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/UpdateParticipantForm' examples: participants/update: value: |- { "processes" : [ { "identifier" : "adf9c140-995e-4be6-a1be-a09add595423" }, { "identifier" : "705d8c8d-8ff1-4c21-a444-3e7481595696" } ], "contact" : { "name" : "Roger Doofenshmirtz", "email" : "roger.doofemshmirtz@evil.inc", "phoneNumber" : "22222233" } } responses: "200": description: "200" content: application/vnd.no.digdir.elma.participants.update.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/Participant' examples: participants/update: value: |- { "identifier" : "a74363a2-1038-4a3f-a599-97ff860787e0", "qualifiedIdentifier" : "iso6523-actorid-upis::0192:222222222", "icd" : "0192", "organizationIdentifier" : "222222222", "name" : "Doofenshmirtz Evil Inc", "registrationDate" : "2001-05-12", "lastModificationDate" : "2020-09-01", "contact" : { "name" : "Roger Doofenshmirtz", "email" : "roger.doofemshmirtz@evil.inc", "phoneNumber" : "22222233" }, "processes" : [ { "identifier" : "705d8c8d-8ff1-4c21-a444-3e7481595696", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:www.cenbii.eu:profile:bii28:ver2.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_28A_2.0", "alias" : "PEPPOL BIS Ordering 2.0 (Profile 28A)", "restricted" : false, "capabilities" : [ ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something" } ], "dependencies" : [ ], "requiredICDs" : [ "9908" ] }, { "identifier" : "adf9c140-995e-4be6-a1be-a09add595423", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_3_0_BILLING_01_UBL", "alias" : "PEPPOL BIS Billing 3.0 (01, UBL)", "restricted" : false, "capabilities" : [ { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa", "title" : "peppolbis_order" } ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something" } ], "dependencies" : [ { "identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep", "title" : "TEST DEPENDENCY", "restricted" : false } ], "requiredICDs" : [ "0192" ] } ] } security: - basic: [] delete: tags: - rest summary: Delete participant description: Delete participant operationId: participants/delete parameters: - name: qualifiedIdentifier in: path description: "An identifier that is qualified by a schema. It consists of\ \ :: : ." required: true schema: type: string responses: "204": description: "204" security: - basic: [] /rest/api/processes/{identifier}: get: tags: - rest summary: Get process description: Get process operationId: processes/get parameters: - name: identifier in: path description: A process identifier that is an UUID. required: true schema: type: string responses: "200": description: "200" content: application/vnd.no.digdir.elma.processes.get.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/Process' examples: processes/get: value: |- { "identifier" : "adf9c140-995e-4be6-a1be-a09add595423", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_3_0_BILLING_01_UBL", "alias" : "PEPPOL BIS Billing 3.0 (01, UBL)", "restricted" : false, "visible" : true, "capabilities" : [ { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa", "title" : "peppolbis_order" } ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something", "visible" : true } ], "dependencies" : [ { "identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep", "title" : "TEST DEPENDENCY", "restricted" : false, "visible" : true } ], "requiredICDs" : [ "0192" ] } security: - basic: [] put: tags: - rest summary: Update process description: Update process operationId: processes/update parameters: - name: identifier in: path description: A process identifier that is an UUID. required: true schema: type: string requestBody: content: application/vnd.no.digdir.elma.processes.update.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/ProcessForm' examples: processes/update: value: |- { "domain" : "Post-Award", "title" : "PEPPOLBIS_3_0_BILLING_01_UBL", "alias" : "PEPPOL BIS Billing 3.0 (01, UBL)", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0", "restricted" : false, "visible" : true, "capabilities" : [ { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa" } ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7" } ], "dependencies" : [ { "identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd" } ], "requiredICDs" : [ "0192" ] } responses: "200": description: "200" content: application/vnd.no.digdir.elma.processes.update.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/Process' examples: processes/update: value: |- { "identifier" : "adf9c140-995e-4be6-a1be-a09add595423", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_3_0_BILLING_01_UBL", "alias" : "PEPPOL BIS Billing 3.0 (01, UBL)", "restricted" : false, "visible" : true, "capabilities" : [ { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa", "title" : "peppolbis_order" } ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something", "visible" : true } ], "dependencies" : [ { "identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep", "title" : "TEST DEPENDENCY", "restricted" : false, "visible" : true } ], "requiredICDs" : [ "0192" ] } security: - basic: [] delete: tags: - rest summary: Delete process description: Delete process operationId: processes/delete parameters: - name: identifier in: path description: A process identifier that is an UUID. required: true schema: type: string responses: "204": description: "204" security: - basic: [] /rest/api/organizations/{qualifiedIdentifier}/processes: get: tags: - rest summary: Find organization processes description: Find organization processes operationId: organizations/processes parameters: - name: qualifiedIdentifier in: path description: "An identifier that is qualified by a schema. It consists of\ \ :: : ." required: true schema: type: string responses: "200": description: "200" content: application/vnd.no.digdir.elma.organizations.processes.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/ProcessList' examples: organizations/processes: value: |- [ { "identifier" : "705d8c8d-8ff1-4c21-a444-3e7481595696", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:www.cenbii.eu:profile:bii28:ver2.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_28A_2.0", "alias" : "PEPPOL BIS Ordering 2.0 (Profile 28A)", "restricted" : false, "visible" : true, "capabilities" : [ ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something", "visible" : true } ], "dependencies" : [ ], "requiredICDs" : [ "9908" ] }, { "identifier" : "adf9c140-995e-4be6-a1be-a09add595423", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_3_0_BILLING_01_UBL", "alias" : "PEPPOL BIS Billing 3.0 (01, UBL)", "restricted" : false, "visible" : true, "capabilities" : [ { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa", "title" : "peppolbis_order" } ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something", "visible" : true } ], "dependencies" : [ { "identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep", "title" : "TEST DEPENDENCY", "restricted" : false, "visible" : true } ], "requiredICDs" : [ "0192" ] } ] security: - basic: [] /rest/api/participants/{identifier}/processes: get: tags: - rest summary: Find participant processes by identifier description: Find participant processes by identifier operationId: participants/processes-by-identifier parameters: - name: identifier in: path description: A participant identifier that is an UUID. required: true schema: type: string responses: "200": description: "200" content: application/vnd.no.digdir.elma.participants.processes.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/ProcessList' examples: participants/processes-by-identifier: value: |- [ { "identifier" : "adf9c140-995e-4be6-a1be-a09add595423", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_3_0_BILLING_01_UBL", "alias" : "PEPPOL BIS Billing 3.0 (01, UBL)", "restricted" : false, "visible" : true, "capabilities" : [ { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa", "title" : "peppolbis_order" } ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something", "visible" : true } ], "dependencies" : [ { "identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep", "title" : "TEST DEPENDENCY", "restricted" : false, "visible" : true } ], "requiredICDs" : [ "0192" ] }, { "identifier" : "705d8c8d-8ff1-4c21-a444-3e7481595696", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:www.cenbii.eu:profile:bii28:ver2.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_28A_2.0", "alias" : "PEPPOL BIS Ordering 2.0 (Profile 28A)", "restricted" : false, "visible" : true, "capabilities" : [ ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something", "visible" : true } ], "dependencies" : [ ], "requiredICDs" : [ "9908" ] } ] security: - basic: [] /rest/api/participants/{qualifiedIdentifier}/processes: get: tags: - rest summary: Find participant processes description: Find participant processes operationId: participants/processes parameters: - name: qualifiedIdentifier in: path description: "An identifier that is qualified by a schema. It consists of\ \ :: : ." required: true schema: type: string responses: "200": description: "200" content: application/vnd.no.digdir.elma.participants.processes.v1+json;charset=UTF-8: schema: $ref: '#/components/schemas/ProcessList' examples: participants/processes: value: |- [ { "identifier" : "adf9c140-995e-4be6-a1be-a09add595423", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:2017:poacc:billing:01:1.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_3_0_BILLING_01_UBL", "alias" : "PEPPOL BIS Billing 3.0 (01, UBL)", "restricted" : false, "capabilities" : [ { "identifier" : "ab5e28f5-703d-4428-8b1f-a417c1ff99aa", "title" : "peppolbis_order" } ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something" } ], "dependencies" : [ { "identifier" : "205391ed-d9d3-494b-a907-ebafc6890ffd", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:fdc:peppol.eu:dep", "title" : "TEST DEPENDENCY", "restricted" : false } ], "requiredICDs" : [ "0192" ] }, { "identifier" : "705d8c8d-8ff1-4c21-a444-3e7481595696", "qualifiedIdentifier" : "cenbii-procid-ubl::urn:www.cenbii.eu:profile:bii28:ver2.0", "domain" : "Post-Award", "title" : "PEPPOLBIS_28A_2.0", "alias" : "PEPPOL BIS Ordering 2.0 (Profile 28A)", "restricted" : false, "capabilities" : [ ], "documentTypes" : [ { "identifier" : "8e83282a-577f-4b06-8207-f8d6674b0da7", "qualifiedIdentifier" : "busdox-docid-qns::urn:oasis:names:specification:ubl:schema:xsd:Order-2::Order##urn:www.cenbii.eu:transaction:biitrns001:ver2.0:extended:urn:www.peppol.eu:bis:peppol28a:ver1.0::2.1", "title" : "something" } ], "dependencies" : [ ], "requiredICDs" : [ "9908" ] } ] security: - basic: [] /rest/api/participants/{qualifiedIdentifier}/transfer/{serviceProviderIdentifier}: put: tags: - rest summary: Transfer participant description: Transfer participant operationId: participants/transfer parameters: - name: qualifiedIdentifier in: path description: "An identifier that is qualified by a schema. It consists of\ \ :: : ." required: true schema: type: string - name: serviceProviderIdentifier in: path description: Identifier of the Service Provider that should receive the participant to be transferred. required: true schema: type: string responses: "200": description: "200" security: - basic: [] components: schemas: AddParticipantForm: title: AddParticipantForm type: object properties: processes: type: array description: A list of processes. items: type: object properties: identifier: type: string description: A UUID identifier. organizationIdentifier: type: string description: "An organization identifier, up to a maximum of 35 characters." contact: type: object properties: phoneNumber: type: string description: The phone number of the contact. name: type: string description: Name of the contact. email: type: string description: Email of the contact. name: type: string description: Organization name icd: type: string description: "An International Code Designator (ICD) value, which uniquely\ \ identifies the authority which issued the code to the organization,\ \ up to 4 digits" UpdateParticipantForm: title: UpdateParticipantForm type: object properties: processes: type: array description: A list of processes. items: type: object properties: identifier: type: string description: A UUID identifier. contact: type: object properties: phoneNumber: type: string description: The phone number of the contact. name: type: string description: Name of the contact. email: type: string description: Email of the contact. Participant: title: Participant type: object properties: identifier: type: string description: A participant identifier that is an UUID. processes: type: array description: List of processes. items: type: object properties: identifier: type: string description: A UUID identifier. capabilities: type: array description: A list of capabilities items: type: object properties: identifier: type: string description: A UUID identifier. title: type: string description: The capability title. visible: type: boolean description: If the process is visible in the SMP lookup. restricted: type: boolean description: If the process has been deprecated. documentTypes: type: array description: A list of document types items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the document type is visible or not in the SMP. qualifiedIdentifier: type: string description: The qualified identifier for the document type. title: type: string description: The document type title. domain: type: string description: The domain that this process belongs to. alias: type: string description: An alias for the process title title: type: string description: A title describing the process. qualifiedIdentifier: type: string description: A qualified identifier that consist of a scheme and a value. requiredICDs: type: array description: A participant must have a ICD contained in this list to be able to add a process. items: oneOf: - type: object - type: boolean - type: string - type: number dependencies: type: array description: A list of dependencies items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the process is visible in the SMP lookup. restricted: type: boolean description: If the process has been deprecated. qualifiedIdentifier: type: string description: The qualified identifier for the dependency. title: type: string description: The dependency title. lastModificationDate: type: string description: Last modification date provider: type: object properties: identifier: type: string description: A universally unique identifier. title: type: string description: The name of service provider. description: The service provider. organizationIdentifier: type: string description: "An organization identifier, up to a maximum of 35 characters." contact: type: object properties: phoneNumber: type: string description: The phone number of the contact. name: type: string description: Name of the contact. email: type: string description: Email of the contact. registrationDate: type: string description: Registration date name: type: string description: Organization name icd: type: string description: "An International Code Designator (ICD) value, which uniquely\ \ identifies the authority which issued the code to the organization,\ \ up to 4 digits" qualifiedIdentifier: type: string description: A qualified identifier that consist of a scheme and a value. deleteDate: type: string description: Date the participant will be deleted. Process: title: Process type: object properties: identifier: type: string description: A UUID identifier. capabilities: type: array description: A list of capabilities items: type: object properties: identifier: type: string description: A UUID identifier. title: type: string description: The capability title. visible: type: boolean description: If the process is visible in the SMP lookup. restricted: type: boolean description: If the process has been deprecated. documentTypes: type: array description: A list of document types items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the document type is visible or not in the SMP. qualifiedIdentifier: type: string description: The qualified identifier for the document type. title: type: string description: The document type title. domain: type: string description: The domain that this process belongs to. alias: type: string description: An alias for the process title title: type: string description: A title describing the process. qualifiedIdentifier: type: string description: A qualified identifier that consist of a scheme and a value. requiredICDs: type: array description: A participant must have a ICD contained in this list to be able to add a process. items: oneOf: - type: object - type: boolean - type: string - type: number dependencies: type: array description: A list of dependencies items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the process is visible in the SMP lookup. restricted: type: boolean description: If the process has been deprecated. qualifiedIdentifier: type: string description: The qualified identifier for the dependency. title: type: string description: The dependency title. DocumentType: title: DocumentType type: object properties: identifier: type: string description: A UUID identifier. processes: type: array description: A list of processes items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the process is visible in the SMP lookup. restricted: type: boolean description: If the process has been deprecated. title: type: string description: The capability title. qualifiedIdentifier: type: string description: A qualified identifier that consist of a scheme and a value. visible: type: boolean description: If the document type is visible in the SMP lookup. title: type: string description: A title describing the document type. qualifiedIdentifier: type: string description: A qualified identifier that consist of a scheme and a value. ParticipantList: title: ParticipantList type: array items: type: object properties: identifier: type: string description: A participant identifier that is an UUID. processes: type: array description: List of processes. items: type: object properties: identifier: type: string description: A UUID identifier. capabilities: type: array description: A list of capabilities items: type: object properties: identifier: type: string description: A UUID identifier. title: type: string description: The capability title. visible: type: boolean description: If the process is visible in the SMP lookup. restricted: type: boolean description: If the process has been deprecated. documentTypes: type: array description: A list of document types items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the document type is visible or not in the SMP. qualifiedIdentifier: type: string description: The qualified identifier for the document type. title: type: string description: The document type title. domain: type: string description: The domain that this process belongs to. alias: type: string description: An alias for the process title title: type: string description: A title describing the process. qualifiedIdentifier: type: string description: A qualified identifier that consist of a scheme and a value. requiredICDs: type: array description: A participant must have a ICD contained in this list to be able to add a process. items: oneOf: - type: object - type: boolean - type: string - type: number dependencies: type: array description: A list of dependencies items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the process is visible in the SMP lookup. restricted: type: boolean description: If the process has been deprecated. qualifiedIdentifier: type: string description: The qualified identifier for the dependency. title: type: string description: The dependency title. lastModificationDate: type: string description: Last modification date provider: type: object properties: identifier: type: string description: A universally unique identifier. title: type: string description: The name of service provider. description: The service provider. organizationIdentifier: type: string description: "An organization identifier, up to a maximum of 35 characters." contact: type: object properties: phoneNumber: type: string description: The phone number of the contact. name: type: string description: Name of the contact. email: type: string description: Email of the contact. registrationDate: type: string description: Registration date name: type: string description: Organization name icd: type: string description: "An International Code Designator (ICD) value, which uniquely\ \ identifies the authority which issued the code to the organization,\ \ up to 4 digits" qualifiedIdentifier: type: string description: A qualified identifier that consist of a scheme and a value. deleteDate: type: string description: Date the participant will be deleted. AccessPoint: title: AccessPoint type: object properties: identifier: type: string description: A universally unique identifier. endpoints: type: array description: A list of endpoints belonging to the access point. items: type: object properties: transportProfile: type: object properties: certificateTypes: type: array description: A list of certificate types that is used by this endpoint. items: oneOf: - type: object - type: boolean - type: string - type: number title: type: string description: Name describing the transport profile. value: type: string description: The transport profile identifier. description: A list of transport profiles supported by the endpoint. url: type: string description: The url of the endpoint. provider: type: object properties: identifier: type: string description: A universally unique identifier. contact: type: object properties: phoneNumber: type: string description: The phone number of the contact. name: type: string description: Name of the contact. email: type: string description: Email of the contact. title: type: string description: The name of service provider. description: The access point provider. title: type: string description: The name of service provider. DocumentTypeForm: title: DocumentTypeForm type: object properties: processes: type: array description: A list of processes items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the document type is visible in the SMP lookup. qualifiedIdentifier: type: string description: A qualified identifier that consist of a scheme and a value. title: type: string description: A title describing the document type. ProcessForm: title: ProcessForm type: object properties: capabilities: type: array description: A list of capabilities items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the process is visible in the SMP lookup. restricted: type: boolean description: If the process has been deprecated. documentTypes: type: array description: A list of document types items: type: object properties: identifier: type: string description: A UUID identifier. domain: type: string description: The domain that this process belongs to. alias: type: string description: An alias for the process title qualifiedIdentifier: type: string description: A qualified identifier that consist of a scheme and a value. title: type: string description: A title describing the process. requiredICDs: type: array description: A participant must have a ICD contained in this list to be able to add a process. items: oneOf: - type: object - type: boolean - type: string - type: number dependencies: type: array description: A list of dependencies items: type: object properties: identifier: type: string description: A UUID identifier. DocumentTypePage: title: DocumentTypePage type: object properties: number: type: number description: The page number numberOfElements: type: number description: Number of elements returned in the page. size: type: number description: The page size last: type: boolean description: A boolean value indicating if this is the last page or not. totalPages: type: number description: The total number of pages pageable: type: object properties: pageNumber: type: number description: The requested page number offset: type: number description: The offset to be taken according to the underlying page and page size. pageSize: type: number description: The requested page size sort: type: object properties: unsorted: type: boolean description: True if the result set is unsorted. False otherwise. sorted: type: boolean description: True if the result set is sorted. False otherwise. empty: type: boolean description: True if no sorting. False otherwise sort: type: object properties: unsorted: type: boolean description: True if the result set is unsorted. False otherwise. sorted: type: boolean description: True if the result set is sorted. False otherwise. empty: type: boolean description: True if no sorting. False otherwise first: type: boolean description: A boolean value indicating if this is the first page or not. content: type: array items: type: object properties: identifier: type: string description: A UUID identifier. processes: type: array description: A list of processes items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the process is visible in the SMP lookup. restricted: type: boolean description: If the process has been deprecated. title: type: string description: The capability title. qualifiedIdentifier: type: string description: A qualified identifier that consist of a scheme and a value. visible: type: boolean description: If the document type is visible in the SMP lookup. title: type: string description: A title describing the document type. qualifiedIdentifier: type: string description: A qualified identifier that consist of a scheme and a value. empty: type: boolean description: True if the page is empty. False if not. totalElements: type: number description: The total number of elements AccessPointPage: title: AccessPointPage type: object properties: number: type: number description: The page number numberOfElements: type: number description: Number of elements returned in the page. size: type: number description: The page size last: type: boolean description: A boolean value indicating if this is the last page or not. totalPages: type: number description: The total number of pages pageable: type: object properties: pageNumber: type: number description: The requested page number offset: type: number description: The offset to be taken according to the underlying page and page size. pageSize: type: number description: The requested page size sort: type: object properties: unsorted: type: boolean description: True if the result set is unsorted. False otherwise. sorted: type: boolean description: True if the result set is sorted. False otherwise. empty: type: boolean description: True if no sorting. False otherwise sort: type: object properties: unsorted: type: boolean description: True if the result set is unsorted. False otherwise. sorted: type: boolean description: True if the result set is sorted. False otherwise. empty: type: boolean description: True if no sorting. False otherwise first: type: boolean description: A boolean value indicating if this is the first page or not. content: type: array items: type: object properties: identifier: type: string description: A universally unique identifier. endpoints: type: array description: A list of endpoints belonging to the access point. items: type: object properties: transportProfile: type: object properties: certificateTypes: type: array description: A list of certificate types that is used by this endpoint. items: oneOf: - type: object - type: boolean - type: string - type: number title: type: string description: Name describing the transport profile. value: type: string description: The transport profile identifier. description: A list of transport profiles supported by the endpoint. url: type: string description: The url of the endpoint. provider: type: object properties: identifier: type: string description: A universally unique identifier. contact: type: object properties: phoneNumber: type: string description: The phone number of the contact. name: type: string description: Name of the contact. email: type: string description: Email of the contact. title: type: string description: The name of service provider. description: The access point provider. title: type: string description: The name of service provider. empty: type: boolean description: True if the page is empty. False if not. totalElements: type: number description: The total number of elements ParticipantPage: title: ParticipantPage type: object properties: number: type: number description: The page number numberOfElements: type: number description: Number of elements returned in the page. size: type: number description: The page size last: type: boolean description: A boolean value indicating if this is the last page or not. totalPages: type: number description: The total number of pages pageable: type: object properties: pageNumber: type: number description: The requested page number offset: type: number description: The offset to be taken according to the underlying page and page size. pageSize: type: number description: The requested page size sort: type: object properties: unsorted: type: boolean description: True if the result set is unsorted. False otherwise. sorted: type: boolean description: True if the result set is sorted. False otherwise. empty: type: boolean description: True if no sorting. False otherwise sort: type: object properties: unsorted: type: boolean description: True if the result set is unsorted. False otherwise. sorted: type: boolean description: True if the result set is sorted. False otherwise. empty: type: boolean description: True if no sorting. False otherwise first: type: boolean description: A boolean value indicating if this is the first page or not. content: type: array items: type: object properties: identifier: type: string description: A participant identifier that is an UUID. processes: type: array description: List of processes. items: type: object properties: identifier: type: string description: A UUID identifier. capabilities: type: array description: A list of capabilities items: type: object properties: identifier: type: string description: A UUID identifier. title: type: string description: The capability title. visible: type: boolean description: If the process is visible in the SMP lookup. restricted: type: boolean description: If the process has been deprecated. documentTypes: type: array description: A list of document types items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the document type is visible or not in the SMP. qualifiedIdentifier: type: string description: The qualified identifier for the document type. title: type: string description: The document type title. domain: type: string description: The domain that this process belongs to. alias: type: string description: An alias for the process title title: type: string description: A title describing the process. qualifiedIdentifier: type: string description: A qualified identifier that consist of a scheme and a value. requiredICDs: type: array description: A participant must have a ICD contained in this list to be able to add a process. items: oneOf: - type: object - type: boolean - type: string - type: number dependencies: type: array description: A list of dependencies items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the process is visible in the SMP lookup. restricted: type: boolean description: If the process has been deprecated. qualifiedIdentifier: type: string description: The qualified identifier for the dependency. title: type: string description: The dependency title. lastModificationDate: type: string description: Last modification date provider: type: object properties: identifier: type: string description: A universally unique identifier. title: type: string description: The name of service provider. description: The service provider. organizationIdentifier: type: string description: "An organization identifier, up to a maximum of 35 characters." contact: type: object properties: phoneNumber: type: string description: The phone number of the contact. name: type: string description: Name of the contact. email: type: string description: Email of the contact. registrationDate: type: string description: Registration date name: type: string description: Organization name icd: type: string description: "An International Code Designator (ICD) value, which\ \ uniquely identifies the authority which issued the code to the\ \ organization, up to 4 digits" qualifiedIdentifier: type: string description: A qualified identifier that consist of a scheme and a value. deleteDate: type: string description: Date the participant will be deleted. empty: type: boolean description: True if the page is empty. False if not. totalElements: type: number description: The total number of elements ProcessList: title: ProcessList type: array items: type: object properties: identifier: type: string description: A UUID identifier. capabilities: type: array description: A list of capabilities items: type: object properties: identifier: type: string description: A UUID identifier. title: type: string description: The capability title. visible: type: boolean description: If the process is visible in the SMP lookup. restricted: type: boolean description: If the process has been deprecated. documentTypes: type: array description: A list of document types items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the document type is visible or not in the SMP. qualifiedIdentifier: type: string description: The qualified identifier for the document type. title: type: string description: The document type title. domain: type: string description: The domain that this process belongs to. alias: type: string description: An alias for the process title title: type: string description: A title describing the process. qualifiedIdentifier: type: string description: A qualified identifier that consist of a scheme and a value. requiredICDs: type: array description: A participant must have a ICD contained in this list to be able to add a process. items: oneOf: - type: object - type: boolean - type: string - type: number dependencies: type: array description: A list of dependencies items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the process is visible in the SMP lookup. restricted: type: boolean description: If the process has been deprecated. qualifiedIdentifier: type: string description: The qualified identifier for the dependency. title: type: string description: The dependency title. ProcessPage: title: ProcessPage type: object properties: number: type: number description: The page number numberOfElements: type: number description: Number of elements returned in the page. size: type: number description: The page size last: type: boolean description: A boolean value indicating if this is the last page or not. totalPages: type: number description: The total number of pages pageable: type: object properties: pageNumber: type: number description: The requested page number offset: type: number description: The offset to be taken according to the underlying page and page size. pageSize: type: number description: The requested page size sort: type: object properties: unsorted: type: boolean description: True if the result set is unsorted. False otherwise. sorted: type: boolean description: True if the result set is sorted. False otherwise. empty: type: boolean description: True if no sorting. False otherwise sort: type: object properties: unsorted: type: boolean description: True if the result set is unsorted. False otherwise. sorted: type: boolean description: True if the result set is sorted. False otherwise. empty: type: boolean description: True if no sorting. False otherwise first: type: boolean description: A boolean value indicating if this is the first page or not. content: type: array items: type: object properties: identifier: type: string description: A UUID identifier. capabilities: type: array description: A list of capabilities items: type: object properties: identifier: type: string description: A UUID identifier. title: type: string description: The capability title. visible: type: boolean description: If the process is visible in the SMP lookup. restricted: type: boolean description: If the process has been deprecated. documentTypes: type: array description: A list of document types items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the document type is visible or not in the SMP. qualifiedIdentifier: type: string description: The qualified identifier for the document type. title: type: string description: The document type title. domain: type: string description: The domain that this process belongs to. alias: type: string description: An alias for the process title title: type: string description: A title describing the process. qualifiedIdentifier: type: string description: A qualified identifier that consist of a scheme and a value. requiredICDs: type: array description: A participant must have a ICD contained in this list to be able to add a process. items: oneOf: - type: object - type: boolean - type: string - type: number dependencies: type: array description: A list of dependencies items: type: object properties: identifier: type: string description: A UUID identifier. visible: type: boolean description: If the process is visible in the SMP lookup. restricted: type: boolean description: If the process has been deprecated. qualifiedIdentifier: type: string description: The qualified identifier for the dependency. title: type: string description: The dependency title. empty: type: boolean description: True if the page is empty. False if not. totalElements: type: number description: The total number of elements securitySchemes: basic: type: http scheme: basic