openapi: 3.2.0 info: title: Fenergo Unwrapping Requirement Status API version: '1.0' description: 'Operations tagged UnwrappingRequirementStatus across 3 of this provider''s published API definitions: fenergo-associationcommand-v1-0-openapi.json, fenergo-associationcommand-v2-0-openapi.json, fenergo-associationquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /associationcommand - url: /associationquery security: - Bearer: [] tags: - name: UnwrappingRequirementStatus paths: /api/unwrapping-requirement-status: post: tags: - UnwrappingRequirementStatus summary: Create new Unwrapping Requirement Status Model description: 'This method will create a new Unwrapping Requirement Status Model The new model will initialize with the DTO data. Required permissions: At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly' operationId: CreateUnwrappingRequirementStatusModel parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.Association.Command.Application.Dto.UnwrappingRequirementStatusDto.CreateUnwrapReqStatusRequestDto to create content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateUnwrapReqStatusRequestDtoServiceRequest' responses: '202': description: Unwrapping Requirement Model created successfully content: application/json: schema: $ref: '#/components/schemas/UnwrappingRequirementStatusModelResponseDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /associationcommand /api/unwrapping-requirement-status/create-single-status: post: tags: - UnwrappingRequirementStatus summary: Create single Unwrapping Requirement Status description: 'This method will create a new Unwrapping Requirement Status The new model will initialize with the DTO data. Parent model will be created if it has not been created already. Required permissions: At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly' operationId: CreateSingleUnwrappingRequirementStatusModel parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.Association.Command.Application.Dto.UnwrappingRequirementStatusDto.CreateUnwrapReqStatusRequestDto to create content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateSingleUnwrappingRequirementStatusRequestDtoServiceRequest' responses: '202': description: Unwrapping Requirement Status created successfully content: application/json: schema: $ref: '#/components/schemas/UnwrappingRequirementStatusModelResponseDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /associationcommand /api/unwrapping-requirement-status/{id}: put: tags: - UnwrappingRequirementStatus summary: Update existing Unwrapping Requirement Status Model description: 'This method will update an existing Unwrapping Requirement Status Model The model will be updated with the DTO data. Required permissions: At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly' operationId: UpdateUnwrappingRequirementStatusModel parameters: - name: id in: path description: The identifier. required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.Association.Command.Application.Dto.UnwrappingRequirementStatusDto.SingleUnwrapReqStatusRequestDto to create content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateUnwrapReqStatusModelRequestDtoServiceRequest' responses: '202': description: Unwrapping Requirement Model created successfully '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - UnwrappingRequirementStatus summary: Get an Unwrapping Requirement Status Model by Id description: 'Get the Unwrapping Requirement Statuses for an Id Required permissions: Following permissions are required: AssociationAccess' operationId: GetUnwrappingRequirementStatusModelById parameters: - name: id in: path description: '' required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UnwrappingRequirementStatusResponseDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '202': description: Unwrapping Requirement Model retrieved successfully '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /associationcommand /api/unwrapping-requirement-status/update-single-status/{id}: put: tags: - UnwrappingRequirementStatus summary: Update single Unwrapping Requirement Status description: 'This method will update a single Unwrapping Requirement Status. Required permissions: At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly' operationId: UpdateSingleUnwrappingRequirementStatusModel parameters: - name: id in: path description: The identifier. required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.Association.Command.Application.Dto.UnwrappingRequirementStatusDto.SingleUnwrapReqStatusRequestDto to create content: application/json: schema: allOf: - $ref: '#/components/schemas/SingleUnwrapReqStatusRequestDtoServiceRequest' responses: '202': description: Unwrapping Requirement Model created successfully '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /associationcommand /api/unwrapping-requirement-status/measure-completeness: post: tags: - UnwrappingRequirementStatus summary: Measures the completeness of Ownership and Control Unwrapping requirements description: 'Required permissions: At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly, AssociationAccess' operationId: MeasureCompleteness parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.Association.MeasureCompleteness.Dto.MeasureCompletenessRequestDto data used in the calculation content: application/json: schema: allOf: - $ref: '#/components/schemas/MeasureCompletenessRequestDtoServiceRequest' responses: '202': description: Unwrapping Requirements successfully evaluated content: application/json: schema: $ref: '#/components/schemas/MeasureCompletenessResponseDtoServiceResponse' '400': description: Validation or permission error occured content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /associationcommand /api/unwrapping-requirement-status/measure-completeness/initiate: post: tags: - UnwrappingRequirementStatus summary: Starts an asynchronous measure-completeness calculation and returns immediately description: 'Creates a BusinessProcess, publishes a service-task event to start the state machine, and returns the business process id. Poll `GET /api/association-business-process/{businessProcessId}` for the result. Each call starts an independent calculation with its own id; there is no server-side superseding, so a second call for the same journey and entity does not affect the first. Concurrent runs are last-writer-wins on the domain model, and the UI collapses duplicate triggers client-side. Required permissions: At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly, AssociationAccess' operationId: InitiateMeasureCompleteness parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.Association.MeasureCompleteness.Dto.MeasureCompletenessRequestDto data used in the calculation content: application/json: schema: allOf: - $ref: '#/components/schemas/MeasureCompletenessRequestDtoServiceRequest' responses: '202': description: Calculation successfully started content: application/json: schema: $ref: '#/components/schemas/InitiateMeasureCompletenessResponseDtoServiceResponse' '400': description: Validation or permission error occured content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /associationcommand /api/v2/unwrapping-requirement-status: post: tags: - UnwrappingRequirementStatus summary: Create new Unwrapping Requirement Status Model description: 'This method will create a new Unwrapping Requirement Status Model The new model will initialize with the DTO data. Required permissions: At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly' operationId: postApiV2UnwrappingRequirementStatus parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.Association.Command.Application.Dto.UnwrappingRequirementStatusDto.CreateUnwrapReqStatusRequestDto to create content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateUnwrapReqStatusRequestDtoServiceRequest' responses: '202': description: Unwrapping Requirement Model created successfully content: application/json: schema: $ref: '#/components/schemas/UnwrappingRequirementStatusModelResponseDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateUnwrappingRequirementStatusModel servers: - url: /associationcommand /api/v2/unwrapping-requirement-status/create-single-status: post: tags: - UnwrappingRequirementStatus summary: Create single Unwrapping Requirement Status description: 'This method will create a new Unwrapping Requirement Status The new model will initialize with the DTO data. Parent model will be created if it has not been created already. Required permissions: At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly' operationId: postApiV2UnwrappingRequirementStatusCreateSingleStatus parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.Association.Command.Application.Dto.UnwrappingRequirementStatusDto.CreateUnwrapReqStatusRequestDto to create content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateSingleUnwrappingRequirementStatusRequestDtoServiceRequest' responses: '202': description: Unwrapping Requirement Status created successfully content: application/json: schema: $ref: '#/components/schemas/UnwrappingRequirementStatusModelResponseDtoServiceResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: CreateSingleUnwrappingRequirementStatusModel servers: - url: /associationcommand /api/v2/unwrapping-requirement-status/{id}: put: tags: - UnwrappingRequirementStatus summary: Update existing Unwrapping Requirement Status Model description: 'This method will update an existing Unwrapping Requirement Status Model The model will be updated with the DTO data. Required permissions: At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly' operationId: putApiV2UnwrappingRequirementStatusById parameters: - name: id in: path description: The identifier. required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.Association.Command.Application.Dto.UnwrappingRequirementStatusDto.SingleUnwrapReqStatusRequestDto to create content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateUnwrapReqStatusModelRequestDtoServiceRequest' responses: '202': description: Unwrapping Requirement Model created successfully '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpdateUnwrappingRequirementStatusModel servers: - url: /associationcommand /api/v2/unwrapping-requirement-status/update-single-status/{id}: put: tags: - UnwrappingRequirementStatus summary: Update single Unwrapping Requirement Status description: 'This method will update a single Unwrapping Requirement Status. Required permissions: At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly' operationId: putApiV2UnwrappingRequirementStatusUpdateSingleStatusById parameters: - name: id in: path description: The identifier. required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.Association.Command.Application.Dto.UnwrappingRequirementStatusDto.SingleUnwrapReqStatusRequestDto to create content: application/json: schema: allOf: - $ref: '#/components/schemas/SingleUnwrapReqStatusRequestDtoServiceRequest' responses: '202': description: Unwrapping Requirement Model created successfully '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: UpdateSingleUnwrappingRequirementStatusModel servers: - url: /associationcommand /api/v2/unwrapping-requirement-status/measure-completeness: post: tags: - UnwrappingRequirementStatus summary: Measures the completeness of Ownership and Control Unwrapping requirements description: 'Required permissions: At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly, AssociationAccess' operationId: postApiV2UnwrappingRequirementStatusMeasureCompleteness parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.Association.MeasureCompleteness.Dto.MeasureCompletenessRequestDto data used in the calculation content: application/json: schema: allOf: - $ref: '#/components/schemas/MeasureCompletenessRequestDtoServiceRequest' responses: '202': description: Unwrapping Requirements successfully evaluated content: application/json: schema: $ref: '#/components/schemas/MeasureCompletenessResponseDtoServiceResponse' '400': description: Validation or permission error occured content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: MeasureCompleteness servers: - url: /associationcommand /api/v2/unwrapping-requirement-status/measure-completeness/initiate: post: tags: - UnwrappingRequirementStatus summary: Starts an asynchronous measure-completeness calculation and returns immediately description: 'Creates a BusinessProcess, publishes a service-task event to start the state machine, and returns the business process id. Poll `GET /api/association-business-process/{businessProcessId}` for the result. Each call starts an independent calculation with its own id; there is no server-side superseding, so a second call for the same journey and entity does not affect the first. Concurrent runs are last-writer-wins on the domain model, and the UI collapses duplicate triggers client-side. Required permissions: At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, AssociationEditAndLinkOnly, AssociationAccess' operationId: postApiV2UnwrappingRequirementStatusMeasureCompletenessInitiate parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.Association.MeasureCompleteness.Dto.MeasureCompletenessRequestDto data used in the calculation content: application/json: schema: allOf: - $ref: '#/components/schemas/MeasureCompletenessRequestDtoServiceRequest' responses: '202': description: Calculation successfully started content: application/json: schema: $ref: '#/components/schemas/InitiateMeasureCompletenessResponseDtoServiceResponse' '400': description: Validation or permission error occured content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT x-operation-id-source: normalized x-operation-id-original: InitiateMeasureCompleteness servers: - url: /associationcommand /api/unwrapping-requirement-status/entity/{entityId}/journey/{journeyId}: get: tags: - UnwrappingRequirementStatus summary: Get an Unwrapping Requirement Status Model by Entity Id and Journey Id description: 'Get the Unwrapping Requirement Statuses for an Entity Id and Journey Id Required permissions: Following permissions are required: AssociationAccess' operationId: GetUnwrappingRequirementStatusModelByEntityIdAndJourneyId parameters: - name: entityId in: path description: '' required: true schema: type: string format: uuid - name: journeyId in: path description: '' required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UnwrappingRequirementStatusResponseDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: An exception occurred while processing the command '202': description: Unwrapping Requirement Model retrieved successfully '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /associationquery components: schemas: UpdateUnwrapReqStatusModelRequestDto: type: object properties: statuses: type: - array - 'null' items: $ref: '#/components/schemas/SingleUnwrapReqStatusRequestDto' description: The statuses of the unwrapping requirements additionalProperties: false description: Contains the information needed to update the status of the Unwrapping Requirement MeasureCompletenessResponseDto: type: object properties: id: type: - string - 'null' journeyId: type: - string - 'null' entityId: type: - string - 'null' statuses: type: - array - 'null' items: $ref: '#/components/schemas/MeasureCompletenessStatusResponse' additionalProperties: false UnwrappingRequirementStatusModelResponseDto: type: object properties: id: type: string description: The unique identifier of the model format: uuid example: 088f2d94-f2e1-4afb-b908-498a76ebf771 entityId: type: string description: The Id of the Entity format: uuid example: 18c086ce-f3e1-4311-af6a-1c3fe4f6b6ba journeyId: type: string description: The Id of the Journey format: uuid example: 088f2d94-f2e1-4afb-b908-498a76ebf771 statuses: type: - array - 'null' items: $ref: '#/components/schemas/UnwrappingRequirementStatusResponseDto' description: The statuses of the unwrapping requirements additionalProperties: false description: Contains all the information needed to store the status of the Unwrapping Requirement CreateSingleUnwrappingRequirementStatusRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateSingleUnwrappingRequirementStatusRequestDto' description: Contains all the information needed to store the status of the Unwrapping Requirement additionalProperties: false CreateSingleUnwrappingRequirementStatusRequestDto: type: object properties: entityId: type: string description: The Id of the Entity format: uuid example: 18c086ce-f3e1-4311-af6a-1c3fe4f6b6ba journeyId: type: string description: The Id of the Journey format: uuid example: 088f2d94-f2e1-4afb-b908-498a76ebf771 status: allOf: - $ref: '#/components/schemas/SingleUnwrapReqStatusRequestDto' description: Contains the data for updating an Unwrapping Requirement Status additionalProperties: false description: Contains all the information needed to store the status of the Unwrapping Requirement ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false SingleUnwrapReqStatusRequestDto: required: - requirementId type: object properties: requirementId: minLength: 1 type: string description: The Id of the Requirement format: uuid example: 580565ee-0700-4aec-854d-8cc9dbb58bc1 status: type: - string - 'null' description: The status of the Unwrapping Requirement example: Completed ownershipAndControlDataKey: type: - string - 'null' description: The DataKey of the Requirement example: addAllUBOs requirementName: type: - string - 'null' description: The Name of the Requirement example: Add All UBOs idvName: type: - string - 'null' description: The name of the Idv Requirement example: Add 2 Directors minimumPartyCount: type: - integer - 'null' description: The Minimum Party Count needed to validate the Requirement format: int32 example: 2 addAllParties: type: - boolean - 'null' description: The attribute which specified if all Related Parties which meet the criteria are to be added example: false overrideReason: type: - string - 'null' description: Optional reviewer-supplied reason for reopening this requirement (transitioning back to InProgress). example: Missing supporting documentation for the previously accepted unwrap. additionalProperties: false description: Contains the data for updating an Unwrapping Requirement Status InitiateMeasureCompletenessResponseDto: type: object properties: businessProcessId: type: string format: uuid additionalProperties: false UpdateUnwrapReqStatusModelRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateUnwrapReqStatusModelRequestDto' description: Contains the information needed to update the status of the Unwrapping Requirement additionalProperties: false MeasureCompletenessRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/MeasureCompletenessRequestDto' additionalProperties: false CreateUnwrapReqStatusRequestDto: type: object properties: entityId: type: string description: The Id of the Entity format: uuid example: 18c086ce-f3e1-4311-af6a-1c3fe4f6b6ba journeyId: type: string description: The Id of the Journey format: uuid example: 088f2d94-f2e1-4afb-b908-498a76ebf771 statuses: type: - array - 'null' items: $ref: '#/components/schemas/SingleUnwrapReqStatusRequestDto' description: The statuses of the unwrapping requirements additionalProperties: false description: Contains all the information needed to store the status of the Unwrapping Requirement MeasureCompletenessRequestDto: type: object properties: id: type: string format: uuid journeyId: type: string format: uuid taskId: type: string format: uuid entityId: type: string format: uuid entityDraftId: type: string format: uuid productDraftId: type: - string - 'null' format: uuid additionalProperties: false UnwrappingRequirementStatusModelResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/UnwrappingRequirementStatusModelResponseDto' description: Contains all the information needed to store the status of the Unwrapping Requirement messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false SingleUnwrapReqStatusRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/SingleUnwrapReqStatusRequestDto' description: Contains the data for updating an Unwrapping Requirement Status additionalProperties: false MeasureCompletenessStatusResponse: type: object properties: requirementId: type: - string - 'null' requirementName: type: - string - 'null' idvName: type: - string - 'null' status: type: - string - 'null' ownershipAndControlDataKey: type: - string - 'null' completedDate: type: - string - 'null' format: date-time minimumPartyCount: type: - integer - 'null' format: int32 addAllParties: type: - boolean - 'null' additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateUnwrapReqStatusRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateUnwrapReqStatusRequestDto' description: Contains all the information needed to store the status of the Unwrapping Requirement additionalProperties: false MeasureCompletenessResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/MeasureCompletenessResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false InitiateMeasureCompletenessResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/InitiateMeasureCompletenessResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false UnwrappingRequirementStatusResponseDto: type: object properties: requirementId: type: string description: The Id of the Requirement format: uuid example: 580565ee-0700-4aec-854d-8cc9dbb58bc1 status: type: - string - 'null' description: The Status of the Unwrapping Requirement example: Completed ownershipAndControlDataKey: type: - string - 'null' description: The DataKey of the Requirement example: addAllUBOs completedDate: type: - string - 'null' description: The date when the Requirement was set to 'Completed' format: date-time example: null requirementName: type: - string - 'null' description: The Name of the Requirement example: Add All UBOs idvName: type: - string - 'null' description: The name of the Idv Requirement example: Add 2 Directors minimumPartyCount: type: - integer - 'null' description: The Minimum Party Count needed to validate the Requirement format: int32 example: 2 addAllParties: type: - boolean - 'null' description: The attribute which specified if all Related Parties which meet the criteria are to be added example: false additionalProperties: false description: Contains all the information needed to store the status of the Unwrapping Requirement ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false UnwrappingRequirementStatusDto: type: object properties: requirementId: type: string description: The Id of the Requirement format: uuid example: 580565ee-0700-4aec-854d-8cc9dbb58bc1 status: type: - string - 'null' description: The Status of the Unwrapping Requirement example: Complete ownershipAndControlDataKey: type: - string - 'null' description: The DataKey of the Requirement example: e28a3705-927b-47cd-98bc-b2ad63a6fa69 completedDate: type: - string - 'null' description: The date when the Requirement was set to 'Completed' format: date-time example: null requirementName: type: - string - 'null' description: The Name of the Requirement example: Add All UBOs idvName: type: - string - 'null' description: The Name of the Idv Requirement example: Add All Directors minimumPartyCount: type: - integer - 'null' description: The Minimum Party Count needed to validate the Requirement format: int32 example: 2 addAllParties: type: - boolean - 'null' description: The attribute which specified if all Related Parties which meet the criteria are to be added example: false additionalProperties: false UnwrappingRequirementStatusResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/UnwrappingRequirementStatusResponseDto_2' description: Contains all the information needed to store the status of the Unwrapping Requirement messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false UnwrappingRequirementStatusResponseDto_2: type: object properties: id: type: string description: The unique identifier of the model format: uuid example: 410871d0-d2c6-4d2f-96ea-2fd652c1a92d entityId: type: string description: The Id of the current Entity format: uuid example: 18c086ce-f3e1-4311-af6a-1c3fe4f6b6ba journeyId: type: string description: The Id of the Journey format: uuid example: 088f2d94-f2e1-4afb-b908-498a76ebf771 statuses: type: - array - 'null' items: $ref: '#/components/schemas/UnwrappingRequirementStatusDto' description: The statuses of the unwrapping requirements additionalProperties: false description: Contains all the information needed to store the status of the Unwrapping Requirement securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-associationcommand-v1-0-openapi.json - fenergo-associationcommand-v2-0-openapi.json - fenergo-associationquery-v1-0-openapi.json