openapi: 3.2.0 info: title: Fenergo Jurisdiction API version: '1.0' description: 'Operations tagged Jurisdiction across 2 of this provider''s published API definitions: fenergo-policycommand-v2-0-openapi.json, fenergo-policyquery-v4-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /policycommand - url: /policyquery security: - Bearer: [] tags: - name: Jurisdiction paths: /api/v2/policies/{entityPolicyId}/jurisdictions: post: tags: - Jurisdiction summary: Create a new policy jurisdiction description: 'Creates a new jurisdiction within the specified policy context Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: CreatePolicyJurisdiction parameters: - name: entityPolicyId in: path description: Policy ID required: true schema: type: string format: uuid - name: workspaceId in: query description: Optional workspace ID 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: Create jurisdiction request content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateEntityPolicyJurisdictionRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Jurisdiction created content: application/json: schema: $ref: '#/components/schemas/CreateEntityPolicyJurisdictionResponseDtoServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found. Policy with a given ID does not exist status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policycommand /api/v2/policies/{entityPolicyId}/jurisdictions/{jurisdictionId}: put: tags: - Jurisdiction summary: Update a policy jurisdiction description: 'Updates an existing jurisdiction within the specified policy context Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: UpdatePolicyJurisdiction parameters: - name: entityPolicyId in: path description: Policy ID required: true schema: type: string format: uuid - name: jurisdictionId in: path description: Jurisdiction ID required: true schema: type: string format: uuid - name: workspaceId in: query description: Optional workspace ID 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: Update jurisdiction request content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateEntityPolicyJurisdictionRequestDtoServiceRequest' description: Service request data responses: '202': description: Success. Jurisdiction updated content: application/json: schema: $ref: '#/components/schemas/UpdateEntityPolicyJurisdictionResponseDtoServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found. Policy or jurisdiction with a given ID does not exist status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT delete: tags: - Jurisdiction summary: Delete a policy jurisdiction description: 'Deletes an existing jurisdiction from the specified policy context Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: DeletePolicyJurisdiction parameters: - name: entityPolicyId in: path description: Policy ID required: true schema: type: string format: uuid - name: jurisdictionId in: path description: Jurisdiction ID required: true schema: type: string format: uuid - name: workspaceId in: query description: Optional workspace ID 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: '202': description: Success. Jurisdiction deleted '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found. Policy or jurisdiction with a given ID does not exist status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policycommand /api/v2/policies/{entityPolicyId}/jurisdictions/{jurisdictionId}/revert: put: tags: - Jurisdiction summary: Revert a policy jurisdiction changes description: 'Reverts changes made to an existing jurisdiction within the specified workspace context Required permissions: Following permissions are required: PolicyConfigurationEdit' operationId: RevertPolicyJurisdiction parameters: - name: entityPolicyId in: path description: Policy ID required: true schema: type: string format: uuid - name: jurisdictionId in: path description: Jurisdiction ID required: true schema: type: string format: uuid - name: workspaceId in: query description: Optional workspace ID 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: '202': description: Success. Jurisdiction reverted '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found. Policy or jurisdiction with a given ID does not exist status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policycommand /api/v4/policies/{entityPolicyId}/jurisdictions: get: tags: - Jurisdiction summary: Get jurisdictions from the current version of the policy description: 'Returns jurisdictions. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: ListJurisdictions parameters: - name: entityPolicyId in: path description: ID of the policy required: true schema: type: string format: uuid - name: PageSize in: query description: Page size schema: maximum: 200 type: integer description: Page size format: int32 example: 100 exclusiveMinimum: 0 example: 100 - name: PaginationToken in: query description: Pagination token schema: type: - string - 'null' description: Pagination token - name: workspaceId in: query description: ID of the workspace. If not provided, default workspace will be used 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: Success. List of jurisdictions is returned content: application/json: schema: $ref: '#/components/schemas/JurisdictionListItemViewModelDtoItemsPageServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery /api/v4/policies/{entityPolicyId}/version/{versionNumber}/jurisdictions: get: tags: - Jurisdiction summary: Get jurisdictions from a specific version of the policy description: 'Returns jurisdictions. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: ListHistoricJurisdictions parameters: - name: entityPolicyId in: path description: ID of the policy required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number of the policy required: true schema: minimum: 1 type: integer format: int32 - name: PageSize in: query description: Page size schema: type: integer format: int32 example: 100 example: 100 - name: PaginationToken in: query description: Pagination token schema: type: string - 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: Success. List of jurisdictions is returned content: application/json: schema: $ref: '#/components/schemas/JurisdictionListItemViewModelDtoItemsPageServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery /api/v4/policies/{entityPolicyId}/jurisdictions/{jurisdictionId}: get: tags: - Jurisdiction summary: Get specific jurisdiction from a specific version of the policy description: 'Returns jurisdiction. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: GetJurisdiction parameters: - name: entityPolicyId in: path description: ID of the policy required: true schema: type: string format: uuid - name: jurisdictionId in: path description: ID of the jurisdiction required: true schema: type: string format: uuid - name: workspaceId in: query description: ID of the workspace. If not provided, default workspace will be used 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: Success. Jurisdiction is returned content: application/json: schema: $ref: '#/components/schemas/JurisdictionViewModelDtoServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery /api/v4/policies/{entityPolicyId}/version/{versionNumber}/jurisdictions/{jurisdictionId}: get: tags: - Jurisdiction summary: Get specific jurisdiction from a specific version of the policy description: 'Returns jurisdiction. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: GetHistoricJurisdiction parameters: - name: entityPolicyId in: path description: ID of the policy required: true schema: type: string format: uuid - name: jurisdictionId in: path description: ID of the jurisdiction required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number of the policy required: true schema: minimum: 1 type: integer format: int32 - 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: Success. Jurisdiction is returned content: application/json: schema: $ref: '#/components/schemas/JurisdictionViewModelDtoServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://tools.ietf.org/html/rfc7231#section-6.5.4 title: Resource not found detail: Not Found status: 404 '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery /api/v4/policies/{entityPolicyId}/jurisdictions/available: get: tags: - Jurisdiction summary: Get all current jurisdictions for a given policy description: 'Returns jurisdiction. Required permissions: Following permissions are required: PolicyConfigurationAccess' operationId: ListAvailableJurisdictions parameters: - name: entityPolicyId in: path description: ID of the policy required: true schema: type: string format: uuid - name: workspaceId in: query description: Optional workspaceId. If provided, changes from this workspace will be included 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: Success. Jurisdictions are returned content: application/json: schema: $ref: '#/components/schemas/JurisdictionNameViewModelDtoItemsPageServiceResponse' '400': description: One or more validation errors occurred content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 title: One or more validation errors occurred detail: Name is required status: 400 errorCode: VALIDATION_ERROR validationErrors: - propertyName: Name errorMessage: Name is required attemptedValue: '' validatorType: NotEmptyValidator '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.3 title: Access to resource is forbidden. detail: 'Access denied. Following permissions are required: Permission1, Permission2' status: 403 '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1 title: Internal server exception. Please, contact your provider. detail: null status: 500 errorCode: INTERNAL_SERVER_ERROR '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/ProblemDetails' example: type: https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.9 title: 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. detail: This endpoint is obsolete and was terminated on yyyy-MM-dd status: 410 errorCode: OBSOLETE_ENDPOINT servers: - url: /policyquery components: schemas: UpdateEntityPolicyJurisdictionRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateEntityPolicyJurisdictionRequestDto' description: Create jurisdiction request additionalProperties: false description: Service request data CreateEntityPolicyJurisdictionRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateEntityPolicyJurisdictionRequestDto' description: Create jurisdiction request additionalProperties: false description: Service request data CreateEntityPolicyJurisdictionResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateEntityPolicyJurisdictionResponseDto' description: Create jurisdiction response messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ValueField: type: object properties: dataSource: type: - string - 'null' description: Value of DataSource used to filter field values field: type: - string - 'null' description: Field value used to validate conditional value additionalProperties: false CreateEntityPolicyJurisdictionResponseDto: required: - jurisdictionId type: object properties: jurisdictionId: type: string description: ID of the jurisdiction format: uuid example: 102c63eb-6be0-481f-98f0-eea7fa29cc01 additionalProperties: false description: Create jurisdiction response CreateEntityPolicyJurisdictionRequestDto: required: - description - name type: object properties: name: maxLength: 60 minLength: 1 type: string description: Name of the jurisdiction example: Global description: maxLength: 255 minLength: 1 type: string description: Description of the jurisdiction example: Default jurisdiction conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Conditions when the jurisdiction is applicable additionalProperties: false description: Create jurisdiction request ConditionDefinitionDto: type: object properties: fieldName: type: - string - 'null' description: Name of the field to evaluate example: EntityType value: type: - array - 'null' items: type: string description: List of values valueId: type: - array - 'null' items: type: string description: List of value ids valueType: type: - string - 'null' description: Type of the value example: text dataSource: type: - string - 'null' description: Data source from which field is retrieved. If empty then Entity Data properties will be used. example: entityDataMetadata operation: type: - string - 'null' description: Logical operation to be performed to match the values example: equal logicalOperation: type: - string - 'null' description: Logical operation to be performed on the operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto valueField: allOf: - $ref: '#/components/schemas/ValueField' description: Field value used for conditional limit validation additionalProperties: false description: Represents condition ProblemDetails: type: object properties: type: type: - string - 'null' title: type: - string - 'null' status: type: - integer - 'null' format: int32 detail: type: - string - 'null' instance: type: - string - 'null' additionalProperties: {} ServiceResponseMessage: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response UpdateEntityPolicyJurisdictionResponseDto: required: - jurisdictionId type: object properties: jurisdictionId: type: string description: ID of the jurisdiction format: uuid example: 102c63eb-6be0-481f-98f0-eea7fa29cc01 additionalProperties: false description: Update jurisdiction response ConditionDto: required: - logicalOperation - name - operands type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: minLength: 1 type: string description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: minLength: 1 type: string description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: minItems: 1 type: array items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto additionalProperties: false description: Represents condition root example: id: 118313c6-91e6-4b05-a537-5a1ab906418f name: Company-type only description: Applicable only when EntityType=Company logicalOperation: AND operands: - fieldName: EntityType value: - string valueType: text operation: equal operands: [] UpdateEntityPolicyJurisdictionResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateEntityPolicyJurisdictionResponseDto' description: Update jurisdiction response messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data UpdateEntityPolicyJurisdictionRequestDto: required: - description - name type: object properties: name: maxLength: 60 minLength: 1 type: string description: Name of the jurisdiction example: Global description: maxLength: 255 minLength: 1 type: string description: Description of the jurisdiction example: Default jurisdiction conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Conditions when the jurisdiction is applicable additionalProperties: false description: Create jurisdiction request JurisdictionViewModelDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JurisdictionViewModelDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data JurisdictionNameViewModelDtoItemsPage: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/JurisdictionNameViewModelDto' description: The items result set paginationToken: type: - string - 'null' description: The token for retrieving the next page of results additionalProperties: false description: Query Result Page JurisdictionListItemViewModelDtoItemsPage: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/JurisdictionListItemViewModelDto' description: The items result set paginationToken: type: - string - 'null' description: The token for retrieving the next page of results additionalProperties: false description: Query Result Page JurisdictionListItemViewModelDtoItemsPageServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JurisdictionListItemViewModelDtoItemsPage' description: Query Result Page messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data JurisdictionNameViewModelDto: type: object properties: jurisdictionId: type: string description: Unique identifier of jurisdiction format: uuid example: 0e5a0bae-bd18-474f-8da7-0afcb3eb987b name: type: - string - 'null' description: Name of Jurisdiction example: Global additionalProperties: false description: Jurisdiction DTO JurisdictionViewModelDto: type: object properties: entityPolicyId: type: string format: uuid versionNumber: type: integer format: int32 jurisdictionId: type: string format: uuid changeType: enum: - Unchanged - Added - Updated - Deleted - Locked type: - string - 'null' lockDetails: allOf: - $ref: '#/components/schemas/LockDetailsDto' name: type: - string - 'null' description: type: - string - 'null' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_2' additionalProperties: false ConditionDto_2: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto additionalProperties: false description: Represents condition root JurisdictionListItemViewModelDto: type: object properties: entityPolicyId: type: string description: Unique identifier of policy format: uuid example: 0e5a0bae-bd18-474f-8da7-0afcb3eb987b versionNumber: type: integer description: Version number of the policy format: int32 example: 1 jurisdictionId: type: string description: Unique identifier of jurisdiction format: uuid example: 0e5a0bae-bd18-474f-8da7-0afcb3eb987b changeType: enum: - Unchanged - Added - Updated - Deleted - Locked type: - string - 'null' description: Change type of the jurisdiction example: Unchanged lockDetails: allOf: - $ref: '#/components/schemas/LockDetailsDto' description: Details of the lock. Null if the ChangeType is not Locked. name: type: - string - 'null' description: Name of the jurisdiction example: Global description: type: - string - 'null' description: Description of the jurisdiction example: Global additionalProperties: false description: Jurisdiction JurisdictionNameViewModelDtoItemsPageServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/JurisdictionNameViewModelDtoItemsPage' description: Query Result Page messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data LockDetailsDto: type: object properties: lockedByWorkspaceId: type: string format: uuid lockedByWorkspaceName: type: - string - 'null' lockChangeType: enum: - Updated - Deleted type: - string - 'null' additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-policycommand-v2-0-openapi.json - fenergo-policyquery-v4-0-openapi.json