API tools faq
paste
Advertisement
trboyden

Descriptor

trboyden
Oct 22nd, 2021
1,396
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
YAML 13.37 KB | None | 0 0
raw download clone embed print report
  1. #% Rest Connector Descriptor 1.0
  2.  
  3. apiSpec:
  4.   url: 'C:\source\MongooseFrameworkConnector\IDORestServiceOpenAPI3.yml'
  5.  
  6. connectorName: Mongoose REST Service
  7. connectorDescription: Access to Mongoose through a RESTful service interface.
  8.  
  9. connectorGav:
  10.   groupId: com.mulesoft.connectors
  11.   artifactId: mongoose-rest-service
  12.   version: 1.0.0-SNAPSHOT
  13.  
  14. baseUri:
  15.   type: parameter
  16.  
  17. endpoints:
  18.   /configurations:
  19.     ignored: false
  20.     operations:
  21.       get:
  22.         description: Returns a list of available configurations for a server
  23.         outputMediaType: application/json
  24.         expects:
  25.           queryParameter:
  26.             configGroup:
  27.               displayName: Config Group
  28.               description: Configuration group name. Use this option when you want to display only the members of the specified configuration group
  29.         ignored: false
  30.   /token/{config}/{username}/{password}:
  31.     ignored: false
  32.     operations:
  33.       get:
  34.         description: Returns a Mongoose token for a specific user which can be used for making authenticated requests when calling the Mongoose REST API directly
  35.         outputMediaType: application/json
  36.         expects:
  37.           uriParameter:
  38.             config:
  39.               displayName: config
  40.               description: Configuration name
  41.             username:
  42.               displayName: username
  43.               description: Username
  44.             password:
  45.               displayName: password
  46.               description: Password
  47.         ignored: false
  48.   /load/{ido}:
  49.     ignored: false
  50.     operations:
  51.       get:
  52.         description: Returns a set of records from a collection
  53.         outputMediaType: application/json
  54.         expects:
  55.           header:
  56.             Authorization:
  57.               displayName: Authorization
  58.               description: 'Token obtained through a call to SecurityToken, or if using the service through ION API, a valid OAuth 2.0 Bearer token (filled in automatically by Swagger UI).'
  59.             X-Infor-MongooseConfig:
  60.               displayName: X Infor Mongoose Config
  61.               description: 'Mongoose configuration to log into; required when using the service through ION API, not needed otherwise.'
  62.           queryParameter:
  63.             properties:
  64.               displayName: properties
  65.               description: 'A comma-delimited property list. Provide‘*’ to include all, except subcollection properties.'
  66.             filter:
  67.               displayName: filter
  68.               description: SQL filter string
  69.             orderBy:
  70.               displayName: Order By
  71.               description: SQL ORDER BY value
  72.             recordCap:
  73.               displayName: Record Cap
  74.               description: 'Sets row cap: -1 = default in Mongoose; 0 = unlimited.'
  75.             distinct:
  76.               displayName: distinct
  77.               description: SQL DISTINCT keyword
  78.             clm:
  79.               displayName: clm
  80.               description: Custom Load Method name
  81.             clmParam:
  82.               displayName: Clm Param
  83.               description: Comma-separated Custom Load Method parameters
  84.             loadType:
  85.               displayName: Load Type
  86.               description: 'Load type, one of FIRST | NEXT | PREVIOUS | LAST'
  87.             bookmark:
  88.               displayName: bookmark
  89.               description: Designate bookmark ID
  90.             pqc:
  91.               displayName: pqc
  92.               description: Post Query Command name
  93.             readOnly:
  94.               displayName: Read Only
  95.               description: 'Read Only flag; if set to ''true'', no ItemId is returned with query'
  96.           uriParameter:
  97.             ido:
  98.               displayName: ido
  99.               description: IDO name
  100.         ignored: false
  101.   /update/{ido}:
  102.     ignored: false
  103.     operations:
  104.       post:
  105.         description: 'Insert, update, or delete one or more records from a collection'
  106.         inputMediaType: application/json
  107.         outputMediaType: application/json
  108.         expects:
  109.           header:
  110.             Authorization:
  111.               displayName: Authorization
  112.               description: 'Token obtained through a call to SecurityToken, or if using the service through ION API, a valid OAuth 2.0 Bearer token (filled in automatically by Swagger UI).'
  113.             X-Infor-MongooseConfig:
  114.               displayName: X Infor Mongoose Config
  115.               description: 'Mongoose configuration to log into; required when using the service through ION API, not needed otherwise.'
  116.           queryParameter:
  117.             refresh:
  118.               displayName: refresh
  119.               description: Refresh after update flag
  120.           uriParameter:
  121.             ido:
  122.               displayName: ido
  123.               description: IDO name
  124.         ignored: false
  125.   /info/{ido}:
  126.     ignored: false
  127.     operations:
  128.       get:
  129.         description: Returns IDO property metadata
  130.         outputMediaType: application/json
  131.         expects:
  132.           header:
  133.             Authorization:
  134.               displayName: Authorization
  135.               description: 'Token obtained through a call to SecurityToken, or if using the service through ION API, a valid OAuth 2.0 Bearer token (filled in automatically by Swagger UI).'
  136.             X-Infor-MongooseConfig:
  137.               displayName: X Infor Mongoose Config
  138.               description: 'Mongoose configuration to log into; required when using the service through ION API, not needed otherwise.'
  139.           uriParameter:
  140.             ido:
  141.               displayName: ido
  142.               description: IDO name
  143.         ignored: false
  144.   /invoke/{ido}:
  145.     ignored: false
  146.     operations:
  147.       post:
  148.         description: Invokes an IDO method
  149.         inputMediaType: application/json
  150.         outputMediaType: application/json
  151.         expects:
  152.           header:
  153.             Authorization:
  154.               displayName: Authorization
  155.               description: 'Token obtained through a call to SecurityToken, or if using the service through ION API, a valid OAuth 2.0 Bearer token (filled in automatically by Swagger UI).'
  156.             X-Infor-MongooseConfig:
  157.               displayName: X Infor Mongoose Config
  158.               description: 'Mongoose configuration to log into; required when using the service through ION API, not needed otherwise.'
  159.           queryParameter:
  160.             method:
  161.               displayName: method
  162.               description: IDO method name
  163.           uriParameter:
  164.             ido:
  165.               displayName: ido
  166.               description: IDO name
  167.         ignored: false
  168.   /aes/{eventName}:
  169.     ignored: false
  170.     operations:
  171.       post:
  172.         description: Fire an AES Event
  173.         inputMediaType: application/json
  174.         outputMediaType: application/json
  175.         expects:
  176.           header:
  177.             Authorization:
  178.               displayName: Authorization
  179.               description: 'Token obtained through a call to SecurityToken, or if using the service through ION API, a valid OAuth 2.0 Bearer token (filled in automatically by Swagger UI).'
  180.             X-Infor-MongooseConfig:
  181.               displayName: X Infor Mongoose Config
  182.               description: 'Mongoose configuration to log into; required when using the service through ION API, not needed otherwise.'
  183.           uriParameter:
  184.             eventName:
  185.               displayName: Event Name
  186.               description: Event name
  187.         ignored: false
  188.   /file/{ido}:
  189.     ignored: false
  190.     operations:
  191.       post:
  192.         description: Upload file
  193.         inputMediaType: application/octet-stream
  194.         outputMediaType: application/json
  195.         expects:
  196.           header:
  197.             Authorization:
  198.               displayName: Authorization
  199.               description: 'Token obtained through a call to SecurityToken, or if using the service through ION API, a valid OAuth 2.0 Bearer token (filled in automatically by Swagger UI).'
  200.             X-Infor-MongooseConfig:
  201.               displayName: X Infor Mongoose Config
  202.               description: 'Mongoose configuration to log into; required when using the service through ION API, not needed otherwise.'
  203.           queryParameter:
  204.             property:
  205.               displayName: property
  206.               description: IDO property
  207.             itemId:
  208.               displayName: Item Id
  209.               description: _ItemId value
  210.           uriParameter:
  211.             ido:
  212.               displayName: ido
  213.               description: IDO name
  214.         ignored: false
  215.       get:
  216.         description: Download file
  217.         outputMediaType: application/octet-stream
  218.         expects:
  219.           header:
  220.             Authorization:
  221.               displayName: Authorization
  222.               description: 'Token obtained through a call to SecurityToken, or if using the service through ION API, a valid OAuth 2.0 Bearer token (filled in automatically by Swagger UI).'
  223.             X-Infor-MongooseConfig:
  224.               displayName: X Infor Mongoose Config
  225.               description: 'Mongoose configuration to log into; required when using the service through ION API, not needed otherwise.'
  226.           queryParameter:
  227.             property:
  228.               displayName: property
  229.               description: IDO property name for storing binary data
  230.             rowPointer:
  231.               displayName: Row Pointer
  232.               description: IDO row pointer
  233.           uriParameter:
  234.             ido:
  235.               displayName: ido
  236.               description: IDO name
  237.         ignored: false
  238.   /docobj/list:
  239.     ignored: false
  240.     operations:
  241.       get:
  242.         description: Returns a list of document objects
  243.         outputMediaType: application/json
  244.         expects:
  245.           header:
  246.             Authorization:
  247.               displayName: Authorization
  248.               description: 'Token obtained through a call to SecurityToken, or if using the service through ION API, a valid OAuth 2.0 Bearer token (filled in automatically by Swagger UI).'
  249.             X-Infor-MongooseConfig:
  250.               displayName: X Infor Mongoose Config
  251.               description: 'Mongoose configuration to log into; required when using the service through ION API, not needed otherwise.'
  252.           queryParameter:
  253.             ido:
  254.               displayName: ido
  255.               description: IDO name. Use this option when you want to display documents from the specified IDO only
  256.             rowPointer:
  257.               displayName: Row Pointer
  258.               description: Referenced IDO row pointer. Use this in tandem with the ido parameter
  259.             docName:
  260.               displayName: Doc Name
  261.               description: Document name
  262.             docExt:
  263.               displayName: Doc Ext
  264.               description: Document extension
  265.             refSeq:
  266.               displayName: Ref Seq
  267.               description: Document RefSequence
  268.         ignored: false
  269.   /docobj/{ido}:
  270.     ignored: false
  271.     operations:
  272.       post:
  273.         description: Upload document object
  274.         inputMediaType: application/octet-stream
  275.         outputMediaType: application/json
  276.         expects:
  277.           header:
  278.             Authorization:
  279.               displayName: Authorization
  280.               description: 'Token obtained through a call to SecurityToken, or if using the service through ION API, a valid OAuth 2.0 Bearer token (filled in automatically by Swagger UI).'
  281.             X-Infor-MongooseConfig:
  282.               displayName: X Infor Mongoose Config
  283.               description: 'Mongoose configuration to log into; required when using the service through ION API, not needed otherwise.'
  284.           queryParameter:
  285.             itemId:
  286.               displayName: Item Id
  287.               description: _ItemId value in Document Object. Use this if you want to update an existing document object
  288.             rowPointer:
  289.               displayName: Row Pointer
  290.               description: Referenced IDO row pointer. Use this if you want to upload a new document object and link it to the referenced IDO and row pointer
  291.             name:
  292.               displayName: name
  293.               description: Document name
  294.             desc:
  295.               displayName: desc
  296.               description: Document description
  297.             ext:
  298.               displayName: ext
  299.               description: Document extension
  300.           uriParameter:
  301.             ido:
  302.               displayName: ido
  303.               description: IDO name
  304.         ignored: false
  305.       get:
  306.         description: Download document object
  307.         outputMediaType: '*/*'
  308.         expects:
  309.           header:
  310.             Authorization:
  311.               displayName: Authorization
  312.               description: 'Token obtained through a call to SecurityToken, or if using the service through ION API, a valid OAuth 2.0 Bearer token (filled in automatically by Swagger UI).'
  313.             X-Infor-MongooseConfig:
  314.               displayName: X Infor Mongoose Config
  315.               description: 'Mongoose configuration to log into; required when using the service through ION API, not needed otherwise.'
  316.           queryParameter:
  317.             rowPointer:
  318.               displayName: Row Pointer
  319.               description: IDO row pointer
  320.             name:
  321.               displayName: name
  322.               description: Document name
  323.             refSeq:
  324.               displayName: Ref Seq
  325.               description: Document RefSequence
  326.           uriParameter:
  327.             ido:
  328.               displayName: ido
  329.               description: IDO name
  330.         ignored: false
  331.  
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!