Skip to content

Latest commit

 

History

History
325 lines (225 loc) · 9.17 KB

TypeAPI.md

File metadata and controls

325 lines (225 loc) · 9.17 KB

TypeAPI

All URIs are relative to https://api.lamp.digital

Method HTTP request Description
typeGetAttachment GET /type/{type_id}/attachment/{attachment_key}
typeGetDynamicAttachment GET /type/{type_id}/attachment/dynamic/{attachment_key}
typeListAttachments GET /type/{type_id}/attachment
typeParent GET /type/{type_id}/parent Find the owner(s) of the resource.
typeSetAttachment PUT /type/{type_id}/attachment/{attachment_key}/{target}
typeSetDynamicAttachment PUT /type/{type_id}/attachment/dynamic/{attachment_key}/{target}

typeGetAttachment

    open class func typeGetAttachment(typeId: String, attachmentKey: String, completion: @escaping (_ data: Any?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import LAMP

let typeId = "typeId_example" // String | 
let attachmentKey = "attachmentKey_example" // String | 

TypeAPI.typeGetAttachment(typeId: typeId, attachmentKey: attachmentKey) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
typeId String
attachmentKey String

Return type

Any

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

typeGetDynamicAttachment

    open class func typeGetDynamicAttachment(typeId: String, attachmentKey: String, invokeAlways: Bool, includeLogs: Bool, ignoreOutput: Bool, completion: @escaping (_ data: Any?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import LAMP

let typeId = "typeId_example" // String | 
let attachmentKey = "attachmentKey_example" // String | 
let invokeAlways = true // Bool | 
let includeLogs = true // Bool | 
let ignoreOutput = true // Bool | 

TypeAPI.typeGetDynamicAttachment(typeId: typeId, attachmentKey: attachmentKey, invokeAlways: invokeAlways, includeLogs: includeLogs, ignoreOutput: ignoreOutput) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
typeId String
attachmentKey String
invokeAlways Bool
includeLogs Bool
ignoreOutput Bool

Return type

Any

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

typeListAttachments

    open class func typeListAttachments(typeId: String, completion: @escaping (_ data: Any?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import LAMP

let typeId = "typeId_example" // String | 

TypeAPI.typeListAttachments(typeId: typeId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
typeId String

Return type

Any

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

typeParent

    open class func typeParent(typeId: String, transform: String? = nil, completion: @escaping (_ data: String?, _ error: Error?) -> Void)

Find the owner(s) of the resource.

Get the parent type identifier of the data structure referenced by the identifier.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import LAMP

let typeId = "typeId_example" // String | 
let transform = "transform_example" // String |  (optional)

// Find the owner(s) of the resource.
TypeAPI.typeParent(typeId: typeId, transform: transform) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
typeId String
transform String [optional]

Return type

String

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

typeSetAttachment

    open class func typeSetAttachment(typeId: String, target: String, attachmentKey: String, body: Any, completion: @escaping (_ data: Any?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import LAMP

let typeId = "typeId_example" // String | 
let target = "target_example" // String | 
let attachmentKey = "attachmentKey_example" // String | 
let body = 987 // Any | 

TypeAPI.typeSetAttachment(typeId: typeId, target: target, attachmentKey: attachmentKey, body: body) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
typeId String
target String
attachmentKey String
body Any

Return type

Any

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

typeSetDynamicAttachment

    open class func typeSetDynamicAttachment(typeId: String, target: String, attachmentKey: String, invokeOnce: Bool, dynamicAttachment: DynamicAttachment, completion: @escaping (_ data: Any?, _ error: Error?) -> Void)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import LAMP

let typeId = "typeId_example" // String | 
let target = "target_example" // String | 
let attachmentKey = "attachmentKey_example" // String | 
let invokeOnce = true // Bool | 
let dynamicAttachment = DynamicAttachment(key: "key_example", from: "from_example", to: "to_example", triggers: [123], language: "language_example", contents: "contents_example", requirements: [123]) // DynamicAttachment | 

TypeAPI.typeSetDynamicAttachment(typeId: typeId, target: target, attachmentKey: attachmentKey, invokeOnce: invokeOnce, dynamicAttachment: dynamicAttachment) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
typeId String
target String
attachmentKey String
invokeOnce Bool
dynamicAttachment DynamicAttachment

Return type

Any

Authorization

Authorization

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]