openapi: 3.2.0 info: title: Open Gateway Operate API Onboarding and Ordering Application API description: "**TMF931 - API Ordering, Developer & Application Onboarding and Management** \n\nThis Operate API specification covers the onboarding operations between Channel Partners and Operators as described by GSMA. It offers a consolidation of multiple TM Forum based APIs into a single specification (a component suite). This API specification proposes : \n- Application Owner (Developer) Management (acceptance, onboarding, lifecycle management) \n- Application Management (acceptance, onboarding, lifecycle management) \n- Service API Management (ordering, retrieving)\n\nThis API is a composite DCS (Domain Context Specialization) of the following TMF Open APIs for Open Gateway context\n- TMF622 Product Ordering Management v5.0\n- TMF637 Product Inventory Management v5.0\n- TMF669 Party Role Management v5.0\n- TMF639 Resource Inventory v5.0\n\nCopyright © TM Forum 2025. All Rights Reserved\n" version: 5.2.1 x-generation-tooling-version: v8.5.15 x-generation-data-model-version: unknown x-generation-date: '2025-12-11T09:49:01.463Z' x-api-id: TMF931 license: name: Apache License 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 servers: - url: '{apiRoot}/openGatewayOperateAPIOnboardingAndOrdering/v5/' variables: apiRoot: default: https://serverRoot/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5 enum: - https://serverRoot/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5 tags: - name: application description: Operations for Application Resource paths: /application: post: tags: - application summary: Creates a Application description: This operation creates a Application entity. operationId: createApplication parameters: - $ref: '#/components/parameters/Fields' requestBody: $ref: '#/components/requestBodies/Application_FVO' responses: '201': $ref: '#/components/responses/201Application' '202': description: Accepted '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' get: tags: - application summary: List or find Application objects description: List or find Application objects operationId: listApplication parameters: - $ref: '#/components/parameters/Fields' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Before' - $ref: '#/components/parameters/After' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Filter' responses: '200': $ref: '#/components/responses/200ApplicationArray' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' /application/{id}: get: tags: - application summary: Retrieves a Application by ID description: This operation retrieves a Application entity. Attribute selection enabled for all first level attributes. operationId: retrieveApplication parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' responses: '200': $ref: '#/components/responses/200Application_Get' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' patch: tags: - application summary: Updates partially a Application description: This operation updates partially a Application entity. operationId: patchApplication parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' requestBody: $ref: '#/components/requestBodies/Application_MVO' responses: '200': $ref: '#/components/responses/200Application_Patch' '202': description: Accepted '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' components: examples: Create_an_Application_request: value: '@type': Application '@baseType': LogicalResource name: Evolve Quest commercialName: Evolve Quest logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html description: Evolve Quest mobile application redirectUrl: - https://channelpartner.com/opengateway/application/evolvequest/redirect jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk category: games applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: https://contact.evolvequest.com - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application description: POST Application Request Example Update_an_Application_with_merge-patch_json_content_type_request: value: '@type': Application operationalState: disable description: An example of a request for updating an Application object. Update_an_Application_with_json-patch_json_content_type_response: value: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest creationDate: '2024-12-02T14:00:00.00Z' commercialName: Evolve Quest logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html description: Evolve Quest mobile application redirectUrl: - https://channelpartner.com/opengateway/application/evolvequest/redirect jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk category: games operationalState: disable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 validFor: startDateTime: '2024-12-02T14:01:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: https://contact.evolvequest.com - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: An example of a response for updating an Application object. Retrieve_a_list_of_Application_response: value: - '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest creationDate: '2024-12-02T14:00:00.00Z' commercialName: Evolve Quest logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html description: Evolve Quest mobile application redirectUrl: - https://channelpartner.com/opengateway/application/evolvequest/redirect jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk category: games operationalState: enable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 validFor: startDateTime: '2024-12-02T14:01:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: https://contact.evolvequest.com - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole - '@type': Application '@baseType': LogicalResource id: '102' href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/102 name: Evolve West creationDate: '2024-12-02T14:10:00.00Z' commercialName: Evolve West logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html description: Evolve West mobile application redirectUrl: - https://channelpartner.com/opengateway/application/evolvequest/redirect jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk category: games operationalState: enable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_west_channelPartner15 validFor: startDateTime: '2024-12-02T14:11:00.00Z' apiConsumerRole: - grantedPermissionSet: - '@type': ApiPermissionSet creationDate: '2025-04-02T15:00:00.00Z' permission: '@type': ApiConsumerPermission managedAssetGroup: '@type': ApiListAssetGroup '@baseType': AssetGroup apiProduct: - '@type': ProductRef id: '123' '@referredType': ApiProduct validFor: startDateTime: '2025-04-02T15:00:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: https://contact.evolvewest.com - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvewest.com channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: A collection of Application representation Update_an_Application_with_json_content_type_request: value: '@type': Application operationalState: disable description: Updating an Application object. Update_an_Application_with_json-patch_json_content_type_request: value: - op: replace path: /operationalState value: disable description: An example of a request for updating an Application object. Update_an_Application_with_json_content_type_response: value: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest creationDate: '2024-12-02T14:00:00.00Z' commercialName: Evolve Quest logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html description: Evolve Quest mobile application redirectUrl: - https://channelpartner.com/opengateway/application/evolvequest/redirect jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk category: games operationalState: disable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 validFor: startDateTime: '2024-12-02T14:01:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: https://contact.evolvequest.com - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: A response after PATCH-ing an Application object. Retrieve_an_Application_with_permissions_from_its_identifier_response: value: '@type': Application '@baseType': LogicalResource id: '102' href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/102 name: Evolve West creationDate: '2024-12-02T14:10:00.00Z' commercialName: Evolve West logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html description: Evolve West mobile application redirectUrl: - https://channelpartner.com/opengateway/application/evolvequest/redirect jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk category: games operationalState: enable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_west_channelPartner15 validFor: startDateTime: '2024-12-02T14:11:00.00Z' apiConsumerRole: - grantedPermissionSet: - '@type': ApiPermissionSet creationDate: '2025-04-02T15:00:00.00Z' permission: '@type': ApiConsumerPermission managedAssetGroup: '@type': ApiListAssetGroup '@baseType': AssetGroup apiProduct: - '@type': ProductRef id: '123' '@referredType': ApiProduct validFor: startDateTime: '2025-04-02T15:00:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: https://contact.evolvewest.com - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvewest.com channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: Application representation Retrieve_an_Application_without_digital_identity_from_its_identifier_response: value: '@type': Application '@baseType': LogicalResource id: '103' href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/103 name: Evolve East creationDate: '2024-12-02T14:20:00.00Z' commercialName: Evolve East logoUrl: https://evolveeast.com/logo.jpg privacyPolicyURL: https://evolveeast.com/privacyPolicy.html description: Evolve East mobile application category: games operationalState: enable approvalStatus: approved applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: https://contact.evolveeast.com - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolveeast.com channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: Application representation Retrieve_a_list_of_Application_with_field_selection_and_filter_response: value: - '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c approvalStatus: approved applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 - '@type': Application '@baseType': LogicalResource id: '102' href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/102 approvalStatus: approved applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole description: A collection of Application with field selection and filter Create_an_Application_response: value: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest creationDate: '2024-12-02T14:00:00.00Z' commercialName: Evolve Quest logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html description: Evolve Quest mobile application redirectUrl: - https://channelpartner.com/opengateway/application/evolvequest/redirect jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk category: games operationalState: enable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: https://contact.evolvequest.com - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: POST Application Response Example Update_an_Application_with_json-patch-query_json_content_type_response: value: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest creationDate: '2024-12-02T14:00:00.00Z' commercialName: Evolve Quest logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html description: Evolve Quest mobile application redirectUrl: - https://channelpartner.com/opengateway/application/evolvequest/redirect jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk category: games operationalState: disable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 validFor: startDateTime: '2024-12-02T14:01:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: https://contact.evolvequest.com - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_124 owner: ChannelPartner externalIdentifierType: Application channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: An example of a response for updating an Application object. Retrieve_an_Application_from_its_identifier_response: value: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest creationDate: '2024-12-02T14:00:00.00Z' commercialName: Evolve Quest logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html description: Evolve Quest mobile application redirectUrl: - https://channelpartner.com/opengateway/application/evolvequest/redirect jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk category: games operationalState: enable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 validFor: startDateTime: '2024-12-02T14:01:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: https://contact.evolvequest.com - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: Application representation Update_an_Application_with_merge-patch_json_content_type_response: value: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest creationDate: '2024-12-02T14:00:00.00Z' commercialName: Evolve Quest logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html description: Evolve Quest mobile application redirectUrl: - https://channelpartner.com/opengateway/application/evolvequest/redirect jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk category: games operationalState: disable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 validFor: startDateTime: '2024-12-02T14:01:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: https://contact.evolvequest.com - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: An example of a response for updating an Application object. Update_an_Application_with_json-patch-query_json_content_type_request: value: - op: replace path: /externalIdentifier?id=application_123 value: '@type': ExternalIdentifier id: application_124 owner: ChannelPartner externalIdentifierType: Application description: An example of a request for updating an Application object. schemas: EntityRef: allOf: - $ref: '#/components/schemas/Extensible' - $ref: '#/components/schemas/Addressable' - type: object description: Entity reference schema to be use for all entityRef class. properties: id: type: string description: The identifier of the referred entity. href: type: string description: The URI of the referred entity. name: type: string description: Name of the referred entity. '@referredType': type: string description: The actual type of the target instance when needed for disambiguation. required: - id Application_MVO: allOf: - $ref: '#/components/schemas/LogicalResource_MVO' - type: object description: Application is a logical resource that can consume API products. It's a specialization of a LogicalResource in the Open Gateway context. properties: commercialName: type: string description: Exact name of the Application as marketed (and known by the end-user). logoUrl: type: string description: Url to retrieve the Application official logo. privacyPolicyURL: type: string description: Url to Application privacy policy, if applicable. redirectUrl: type: array items: type: string description: After a user successfully authorizes an application, the authorization server will redirect the user back to the application. jwksUri: type: string description: 'Uri pointing to a JSON Web Key (JWK) : data structure that represents a cryptographic key' category: $ref: '#/components/schemas/ApplicationCategoryType' approvalStatusReason: type: string description: The reason why the approval state changed. DEPRECATED in the PATCH (bug to be fixed on next major version). privacyRightsRequestContact: type: array items: $ref: '#/components/schemas/ContactMedium' description: Contact information for the exercise of data protection rights to which the End Users can address. Must be only EmailContactMedium or WebFormContactMedium for this context. digitalIdentity: $ref: '#/components/schemas/ApiDigitalIdentity_MVO' JsonPatchOperations: description: JSONPatch Operations document as defined by RFC 6902 type: array items: $ref: '#/components/schemas/JsonPatch' Extensible: type: object description: Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type properties: '@type': type: string description: When sub-classing, this defines the sub-class Extensible name '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string description: A URI to a JSON-Schema file that defines additional attributes and relationships required: - '@type' LogicalResourceRole: type: object description: A logical Resource Role is a role given to a logical resource in a given context. properties: grantedPermissionSet: description: The PermissionSet is a set of Permissions granted to a user (party, party role, resource or resource role). The set may be granted explicitly by an authorized user or may be acquired implicitly due to the role that the user is playing. type: array items: $ref: '#/components/schemas/ApiPermissionSet' TimePeriod: type: object description: A period of time, either as a deadline (endDateTime only) a startDateTime only, or both properties: startDateTime: description: Start of the time period, using IETC-RFC-3339 format type: string format: date-time example: '1985-04-12T23:20:50.52Z' endDateTime: description: End of the time period, using IETC-RFC-3339 format type: string format: date-time example: '1985-04-12T23:20:50.52Z' JsonPatch: type: object description: A JSONPatch document as defined by RFC 6902 required: - op - path properties: op: type: string description: The operation to be performed enum: - add - remove - replace - move - copy - test path: type: string description: A JSON-Pointer value: description: The value to be used within the operations. from: type: string description: A string containing a JSON Pointer value. ApiConsumerPermission: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: An ApiConsumerPermission allows an Application to consume an API. properties: managedAssetGroup: $ref: '#/components/schemas/ApiListAssetGroup' discriminator: propertyName: '@type' mapping: ApiConsumerPermission: '#/components/schemas/ApiConsumerPermission' Entity: type: object description: Base entity schema for use in TMForum Open-APIs. Property. allOf: - $ref: '#/components/schemas/Extensible' - $ref: '#/components/schemas/Addressable' ApiListAssetGroup: allOf: - $ref: '#/components/schemas/AssetGroup' - type: object description: Defines a group of API assets to which access can be controlled properties: apiProduct: type: array items: $ref: '#/components/schemas/ProductRef' description: The list of products for which permissions are given. ExternalIdentifier: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list. properties: owner: type: string description: Name of the external system that owns the entity. example: MagentoCommerce externalIdentifierType: type: string description: Type of the identification, typically would be the type of the entity within the external system example: ProductOrder id: type: string description: identification of the entity within the external system. discriminator: propertyName: '@type' mapping: ExternalIdentifier: '#/components/schemas/ExternalIdentifier' ContactMedium_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: 'Indicates the contact medium that could be used to contact the party. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : EmailContactMedium, FaxContactMedium, PhoneContactMedium, GeographicAddressContactMedium, SocialMediaContactMedium...' properties: id: type: string description: Identifier for this contact medium. preferred: type: boolean description: If true, indicates that is the preferred contact medium contactType: type: string description: Type of the contact medium to qualify it like pro email / personal email. This is not used to define the contact medium used. validFor: $ref: '#/components/schemas/TimePeriod' discriminator: propertyName: '@type' mapping: ContactMedium: '#/components/schemas/ContactMedium_FVO' EmailContactMedium: '#/components/schemas/EmailContactMedium' FaxContactMedium: '#/components/schemas/FaxContactMedium' GeographicAddressContactMedium: '#/components/schemas/GeographicAddressContactMedium' PhoneContactMedium: '#/components/schemas/PhoneContactMedium' SocialContactMedium: '#/components/schemas/SocialContactMedium' WebFormContactMedium: '#/components/schemas/WebFormContactMedium_FVO' ExternalIdentifier_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list. properties: owner: type: string description: Name of the external system that owns the entity. example: MagentoCommerce externalIdentifierType: type: string description: Type of the identification, typically would be the type of the entity within the external system example: ProductOrder id: type: string description: identification of the entity within the external system. required: - id discriminator: propertyName: '@type' mapping: ExternalIdentifier: '#/components/schemas/ExternalIdentifier_FVO' Application_RES: type: object description: Response object for Application allOf: - $ref: '#/components/schemas/Application' required: - id - href Error: discriminator: propertyName: '@type' mapping: Error: '#/components/schemas/Error' allOf: - $ref: '#/components/schemas/Extensible' - type: object required: - code - reason properties: code: type: string description: Application relevant detail, defined in the API or a common list. reason: type: string description: Explanation of the reason for the error which can be shown to a client user. message: type: string description: More details and corrective actions related to the error which can be shown to a client user. status: type: string description: HTTP Error code extension referenceError: type: string description: URI of documentation describing the error. description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx) ApiDigitalIdentity_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: ApiDigitalIdentity is a class that allow to describe a digital identity for an individual or a resource or a specific party role. One of these three MUST be provided. If an individual is provided, this identity will be for all her/his partyRole. To avoid confusion it is recommended in this case to not provide partyRoleIdentified. DEPRECATED in the POST and PATCH, this attribute can't be valued by the API consumer in this context. properties: clientId: type: string description: 'OAuth2 Client ID: A public identifier for apps. Even though it is public, it is best that it is not guessable by third parties, so many implementations use something like a 32-character hex string. DEPRECATED in the POST and the PATCH, this attribute can''t be valued by the API consumer in this context.' redirectUrl: type: array deprecated: true items: type: string description: 'DEPRECATED : moved to Application schema. After a user successfully authorizes an application, the authorization server will redirect the user back to the application.' jwksUri: deprecated: true type: string description: 'DEPRECATED : moved to Application schema. JSON Web Key (JWK) is a data structure that represents a cryptographic key' discriminator: propertyName: '@type' mapping: ApiDigitalIdentity: '#/components/schemas/ApiDigitalIdentity_FVO' LogicalResource_MVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory. properties: description: type: string description: free-text description of the resource name: type: string description: the name of the resource operationalState: $ref: '#/components/schemas/ResourceOperationalStateType' resourceVersion: type: string description: A field that identifies the specific version of an instance of a resource. externalIdentifier: type: array description: An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system. items: $ref: '#/components/schemas/ExternalIdentifier' discriminator: propertyName: '@type' mapping: Application: '#/components/schemas/Application_MVO' LogicalResource: '#/components/schemas/LogicalResource_MVO' OAuth2ClientCredential: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: OAuth2ClientCredential describes the registration attributes in an OAuth registration process properties: clientSecret: type: string description: Secret that permits the Application to authenticate with OAuth2 method. state: type: string description: Used to indicate the current lifecycle state of this credential (like active, inactive, expired). validFor: $ref: '#/components/schemas/TimePeriod' discriminator: propertyName: '@type' mapping: OAuth2ClientCredential: '#/components/schemas/OAuth2ClientCredential' Application: allOf: - $ref: '#/components/schemas/LogicalResource' - type: object description: Application is a logical resource that can consume API products. It's a specialization of a LogicalResource in the Open Gateway context. properties: commercialName: type: string description: Exact name of the Application as marketed (and known by the end-user). logoUrl: type: string description: Url to retrieve the Application official logo. privacyPolicyURL: type: string description: Url to Application privacy policy, if applicable. redirectUrl: type: array items: type: string description: After a user successfully authorizes an application, the authorization server will redirect the user back to the application. jwksUri: type: string description: 'Uri pointing to a JSON Web Key (JWK) : data structure that represents a cryptographic key' category: $ref: '#/components/schemas/ApplicationCategoryType' approvalStatus: $ref: '#/components/schemas/ApprovalStatusType' approvalStatusReason: type: string description: The reason why the approval state changed. DEPRECATED in the PATCH (bug to be fixed on next major version). applicationOwner: $ref: '#/components/schemas/PartyRoleRef' privacyRightsRequestContact: type: array items: $ref: '#/components/schemas/ContactMedium' description: Contact information for the exercise of data protection rights to which the End Users can address. Must be only EmailContactMedium or WebFormContactMedium for this context. channelPartner: $ref: '#/components/schemas/PartyRoleRef' digitalIdentity: $ref: '#/components/schemas/ApiDigitalIdentity' apiConsumerRole: type: array items: $ref: '#/components/schemas/LogicalResourceRole' description: Each GSMA Service-API plays a role, and has specific permissions for use creationDate: type: string format: date-time description: Date and time when the Application was created AssetGroup: type: object description: Defines a group of assets (entities) to which access can be controlled. Specific subclasses allow definition in various ways (list of entities, queries, ownership by customer, etc.). AssetGroup is not a managed entity, its concrete subclasses are always included by value in their containing entities. allOf: - $ref: '#/components/schemas/Extensible' discriminator: propertyName: '@type' mapping: ApiListAssetGroup: '#/components/schemas/ApiListAssetGroup' AssetGroup: '#/components/schemas/AssetGroup' ResourceOperationalStateType: enum: - enable - disable type: string description: 'ResourceOperationalStateType enumerations; values defined by ITU X.731: ''disable'': The resource is totally inoperable and unable to provide service to the user(s); ''enable'': The resource is partially or fully operable and available for use.' Addressable: type: object description: Base schema for addressable entities properties: href: type: string description: Hyperlink reference id: type: string description: unique identifier ContactMedium: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: 'Indicates the contact medium that could be used to contact the party. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : EmailContactMedium, FaxContactMedium, PhoneContactMedium, GeographicAddressContactMedium, SocialMediaContactMedium...' properties: id: type: string description: Identifier for this contact medium. preferred: type: boolean description: If true, indicates that is the preferred contact medium contactType: type: string description: Type of the contact medium to qualify it like pro email / personal email. This is not used to define the contact medium used. validFor: $ref: '#/components/schemas/TimePeriod' discriminator: propertyName: '@type' mapping: ContactMedium: '#/components/schemas/ContactMedium' EmailContactMedium: '#/components/schemas/EmailContactMedium' FaxContactMedium: '#/components/schemas/FaxContactMedium' GeographicAddressContactMedium: '#/components/schemas/GeographicAddressContactMedium' PhoneContactMedium: '#/components/schemas/PhoneContactMedium' SocialContactMedium: '#/components/schemas/SocialContactMedium' WebFormContactMedium: '#/components/schemas/WebFormContactMedium' ApiDigitalIdentity_MVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: ApiDigitalIdentity is a class that allow to describe a digital identity for an individual or a resource or a specific party role. One of these three MUST be provided. If an individual is provided, this identity will be for all her/his partyRole. To avoid confusion it is recommended in this case to not provide partyRoleIdentified. DEPRECATED in the POST and PATCH, this attribute can't be valued by the API consumer in this context. properties: clientId: type: string description: 'OAuth2 Client ID: A public identifier for apps. Even though it is public, it is best that it is not guessable by third parties, so many implementations use something like a 32-character hex string. DEPRECATED in the POST and the PATCH, this attribute can''t be valued by the API consumer in this context.' redirectUrl: type: array deprecated: true items: type: string description: 'DEPRECATED : moved to Application schema. After a user successfully authorizes an application, the authorization server will redirect the user back to the application.' jwksUri: deprecated: true type: string description: 'DEPRECATED : moved to Application schema. JSON Web Key (JWK) is a data structure that represents a cryptographic key' discriminator: propertyName: '@type' mapping: ApiDigitalIdentity: '#/components/schemas/ApiDigitalIdentity_MVO' ApiPermissionSet: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: The PermissionSet is a set of Permissions granted to a user (party, party role or resource). The set may be granted explicitly by an authorized user or may be acquired implicitly due to the role that the user is playing. properties: creationDate: type: string format: date-time description: Date when the PermissionSet was created and assigned to a user description: type: string description: Text describing the permission set validFor: $ref: '#/components/schemas/TimePeriod' permission: $ref: '#/components/schemas/ApiConsumerPermission' discriminator: propertyName: '@type' mapping: ApiPermissionSet: '#/components/schemas/ApiPermissionSet' Application_FVO: allOf: - $ref: '#/components/schemas/LogicalResource_FVO' - type: object description: Application is a logical resource that can consume API products. It's a specialization of a LogicalResource in the Open Gateway context. properties: commercialName: type: string description: Exact name of the Application as marketed (and known by the end-user). logoUrl: type: string description: Url to retrieve the Application official logo. privacyPolicyURL: type: string description: Url to Application privacy policy, if applicable. redirectUrl: type: array items: type: string description: After a user successfully authorizes an application, the authorization server will redirect the user back to the application. jwksUri: type: string description: 'Uri pointing to a JSON Web Key (JWK) : data structure that represents a cryptographic key' category: $ref: '#/components/schemas/ApplicationCategoryType' applicationOwner: $ref: '#/components/schemas/PartyRoleRef' privacyRightsRequestContact: type: array items: $ref: '#/components/schemas/ContactMedium_FVO' description: Contact information for the exercise of data protection rights to which the End Users can address. Must be only EmailContactMedium or WebFormContactMedium for this context. digitalIdentity: $ref: '#/components/schemas/ApiDigitalIdentity_FVO' required: - commercialName - applicationOwner - description ProductRef: type: object description: A Product reference allOf: - $ref: '#/components/schemas/EntityRef' discriminator: propertyName: '@type' mapping: ProductRef: '#/components/schemas/ProductRef' LogicalResource_FVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory. properties: description: type: string description: free-text description of the resource name: type: string description: the name of the resource resourceVersion: type: string description: A field that identifies the specific version of an instance of a resource. externalIdentifier: type: array description: An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system. items: $ref: '#/components/schemas/ExternalIdentifier_FVO' required: - name discriminator: propertyName: '@type' mapping: Application: '#/components/schemas/Application_FVO' LogicalResource: '#/components/schemas/LogicalResource_FVO' ApiDigitalIdentity: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: ApiDigitalIdentity is a class that allow to describe a digital identity for an individual or a resource or a specific party role. One of these three MUST be provided. If an individual is provided, this identity will be for all her/his partyRole. To avoid confusion it is recommended in this case to not provide partyRoleIdentified. DEPRECATED in the POST and PATCH, this attribute can't be valued by the API consumer in this context. properties: clientId: type: string description: 'OAuth2 Client ID: A public identifier for apps. Even though it is public, it is best that it is not guessable by third parties, so many implementations use something like a 32-character hex string. DEPRECATED in the POST and the PATCH, this attribute can''t be valued by the API consumer in this context.' redirectUrl: type: array deprecated: true items: type: string description: 'DEPRECATED : moved to Application schema. After a user successfully authorizes an application, the authorization server will redirect the user back to the application.' jwksUri: deprecated: true type: string description: 'DEPRECATED : moved to Application schema. JSON Web Key (JWK) is a data structure that represents a cryptographic key' validFor: $ref: '#/components/schemas/TimePeriod' status: type: string description: Used to indicate the current lifecycle status of this digital identity (unknown, active, suspended, archived). credential: type: array description: A list of credential/authentification method that are used for this digital identity. items: $ref: '#/components/schemas/OAuth2ClientCredential' discriminator: propertyName: '@type' mapping: ApiDigitalIdentity: '#/components/schemas/ApiDigitalIdentity' PartyRoleRef: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: Party role reference. A party role represents the part played by a party in a given context. properties: partyId: type: string description: The identifier of the engaged party that is linked to the PartyRole object. partyName: type: string description: The name of the engaged party that is linked to the PartyRole object. discriminator: propertyName: '@type' mapping: PartyRoleRef: '#/components/schemas/PartyRoleRef' ApplicationCategoryType: enum: - agriculture - artAndDesign - autoAndVehicle - beauty - booksAndReference - business - construction - defense - developerTools - education - engineering - eventsAndEntertainment - finance - foodAndDrink - games - healthAndFitness - healthcare - information - kids - librariesAndDemo - lifestyle - manufacturing - mapsAndNavigation - media - medical - mining - musicAndAudio - newsAndMagazines - organizations - other - photoAndVideo - productivity - publicService - realEstate - shopping - socialNetworkingAndCommunications - sports - tourism - utilities - trading - transportation - travelAndLocal - water - weather type: string description: Valid values for the category of the Application. Please refer to main Application stores in order to retrieve a more precise definition of the categories. LogicalResource: allOf: - $ref: '#/components/schemas/Entity' - type: object description: Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory. properties: description: type: string description: free-text description of the resource name: type: string description: the name of the resource operationalState: $ref: '#/components/schemas/ResourceOperationalStateType' resourceVersion: type: string description: A field that identifies the specific version of an instance of a resource. externalIdentifier: type: array description: An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system. items: $ref: '#/components/schemas/ExternalIdentifier' discriminator: propertyName: '@type' mapping: Application: '#/components/schemas/Application' LogicalResource: '#/components/schemas/LogicalResource' ApprovalStatusType: enum: - pendingApproval - approved - rejected type: string description: Valid values for an ApprovalStatus in the context of an approval process. headers: X-Total-Count: description: Total number of items matching criteria schema: type: integer X-Result-Count: description: Actual number of items returned in the response body schema: type: integer responses: '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Not Implemented Error value: '@type': Error code: ERR501 reason: The requested operation is not implemented message: The requested operation is not implemented. Please contact the system administrator. referenceError: https://host/errors 200ApplicationArray: description: Success headers: X-Total-Count: $ref: '#/components/headers/X-Total-Count' X-Result-Count: $ref: '#/components/headers/X-Result-Count' content: application/json: schema: type: array items: $ref: '#/components/schemas/Application_RES' examples: Retrieve_a_list_of_Application: $ref: '#/components/examples/Retrieve_a_list_of_Application_response' Retrieve_a_list_of_Application_with_field_selection_and_filter: $ref: '#/components/examples/Retrieve_a_list_of_Application_with_field_selection_and_filter_response' '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Service Unavailable Error value: '@type': Error code: ERR503 reason: Service Unavailable message: The service is currently unavailable. Please try again later. referenceError: https://host/errors '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Forbidden Error value: '@type': Error code: ERR403 reason: Forbidden message: You don't have the permission to access the requested resource. It is either read-protected or not readable by the server. referenceError: https://host/errors '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Conflict Error value: '@type': Error code: ERR409 reason: Conflict message: The request could not be completed due to a conflict with the current state of the target resource. referenceError: https://host/errors '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Unauthorized Error value: '@type': Error code: ERR401 reason: Unauthorized message: You are not authorized to access the requested resource. Please provide the correct credentials. referenceError: https://host/errors 200Application_Get: description: Success content: application/json: schema: $ref: '#/components/schemas/Application_RES' examples: Retrieve_an_Application_from_its_identifier: $ref: '#/components/examples/Retrieve_an_Application_from_its_identifier_response' Retrieve_an_Application_with_permissions_from_its_identifier: $ref: '#/components/examples/Retrieve_an_Application_with_permissions_from_its_identifier_response' Retrieve_an_Application_without_digital_identity_from_its_identifier: $ref: '#/components/examples/Retrieve_an_Application_without_digital_identity_from_its_identifier_response' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Bad Request Error value: '@type': Error code: ERR400 reason: Bad Request message: The server could not understand the request due to invalid syntax. Please correct the syntax and try again. referenceError: https://host/errors 200Application_Patch: description: Success content: application/json: schema: $ref: '#/components/schemas/Application_RES' examples: Update_an_Application_with_json_content_type: $ref: '#/components/examples/Update_an_Application_with_json_content_type_response' Update_an_Application_with_merge-patch_json_content_type: $ref: '#/components/examples/Update_an_Application_with_merge-patch_json_content_type_response' Update_an_Application_with_json-patch_json_content_type: $ref: '#/components/examples/Update_an_Application_with_json-patch_json_content_type_response' Update_an_Application_with_json-patch-query_json_content_type: $ref: '#/components/examples/Update_an_Application_with_json-patch-query_json_content_type_response' '405': description: Method Not allowed content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Method Not allowed Error value: '@type': Error code: ERR405 reason: Method Not allowed message: The method is not allowed for the requested URL. referenceError: https://host/errors '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Not Found Error value: '@type': Error code: ERR404 reason: Not Found message: The requested URL was not found on the server. referenceError: https://host/errors '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Internal Server Error example value: '@type': Error code: ERR500 reason: Internal Server Error message: The server encountered an internal error. Please contact the system administrator. referenceError: https://host/errors 201Application: description: Created content: application/json: schema: $ref: '#/components/schemas/Application_RES' examples: Create_an_Application: $ref: '#/components/examples/Create_an_Application_response' parameters: Fields: name: fields in: query description: Comma-separated properties to be provided in response schema: type: string Filter: name: filter in: query description: Filter a collection using JSONPath schema: type: string example: attachment[?(@size==300)] Offset: name: offset in: query description: Requested index for start of resources to be provided in response schema: type: integer Id: name: id required: true schema: type: string in: path description: Identifier of the Resource Limit: name: limit in: query description: Requested number of resources to be provided in response schema: type: integer Sort: name: sort in: query description: The default direction is Ascending order, the use of the modifier in front of the sort field name, “-“, changes the sort order direction. schema: type: string After: name: after in: query description: An opaque string value representing the page results after the cursor value schema: type: string Before: name: before in: query description: An opaque string value representing the page results before the cursor value schema: type: string requestBodies: Application_FVO: description: The Application to be created content: application/json: schema: $ref: '#/components/schemas/Application_FVO' examples: Create_an_Application: $ref: '#/components/examples/Create_an_Application_request' required: true Application_MVO: description: The Application to be patched content: application/json: schema: $ref: '#/components/schemas/Application_MVO' examples: Update_an_Application_with_json_content_type: $ref: '#/components/examples/Update_an_Application_with_json_content_type_request' application/merge-patch+json: schema: $ref: '#/components/schemas/Application_MVO' examples: Update_an_Application_with_merge-patch_json_content_type: $ref: '#/components/examples/Update_an_Application_with_merge-patch_json_content_type_request' application/json-patch+json: schema: $ref: '#/components/schemas/JsonPatchOperations' examples: Update_an_Application_with_json-patch_json_content_type: $ref: '#/components/examples/Update_an_Application_with_json-patch_json_content_type_request' application/json-patch-query+json: schema: $ref: '#/components/schemas/JsonPatchOperations' examples: Update_an_Application_with_json-patch-query_json_content_type: $ref: '#/components/examples/Update_an_Application_with_json-patch-query_json_content_type_request' required: true