Jump to

• Request
• Response

Create an integration setup

post

/fscmRestApi/resources/11.13.18.05/publicSectorIntegrationSetups

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  The unique identifier for the agency associated with the integration setup. Value is mandatory.
• IcsIntegrationName: string
  Title: Integration Name

  Maximum Length: 50

  The Oracle Integration Cloud Service integration name. Value is mandatory.
• IcsIntegrationVersion: string
  Title: Integration Version

  Maximum Length: 10

  The Oracle Integration Cloud Service integration version. Value is mandatory.
• IntegrationSubType: string
  Title: Integration Subtype

  Maximum Length: 30

  The integration subtype.
• IntegrationType: string
  Title: Integration Type

  Maximum Length: 30

  The integration type. Value is mandatory.
• IntEnabledFlag: boolean
  Title: Integration Enabled

  Maximum Length: 1

  Default Value: false

  Indicates whether the integration is enabled.
• Parameter: string
  Title: Integration Parameter

  Maximum Length: 240

  A parameter for the integration setup.
• ResEndPoint: string
  Title: Integration Endpoint

  Maximum Length: 50

  The rest end point.

{
    "type":"object",
    "properties":{
        "ResEndPoint":{
            "title":"Integration Endpoint",
            "maxLength":50,
            "type":"string",
            "description":"The rest end point.",
            "nullable":true
        },
        "IcsIntegrationVersion":{
            "title":"Integration Version",
            "maxLength":10,
            "type":"string",
            "description":"The Oracle Integration Cloud Service integration version. Value is mandatory.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency associated with the integration setup. Value is mandatory.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":1
            }
        },
        "IntEnabledFlag":{
            "title":"Integration Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the integration is enabled.",
            "nullable":false,
            "default":false
        },
        "IcsIntegrationName":{
            "title":"Integration Name",
            "maxLength":50,
            "type":"string",
            "description":"The Oracle Integration Cloud Service integration name. Value is mandatory.",
            "nullable":false
        },
        "Parameter":{
            "title":"Integration Parameter",
            "maxLength":240,
            "type":"string",
            "description":"A parameter for the integration setup.",
            "nullable":true
        },
        "IntegrationSubType":{
            "title":"Integration Subtype",
            "maxLength":30,
            "type":"string",
            "description":"The integration subtype.",
            "nullable":true
        },
        "IntegrationType":{
            "title":"Integration Type",
            "maxLength":30,
            "type":"string",
            "description":"The integration type. Value is mandatory.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorIntegrationSetups-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  The unique identifier for the agency associated with the integration setup. Value is mandatory.
• IcsIntegrationName: string
  Title: Integration Name

  Maximum Length: 50

  The Oracle Integration Cloud Service integration name. Value is mandatory.
• IcsIntegrationVersion: string
  Title: Integration Version

  Maximum Length: 10

  The Oracle Integration Cloud Service integration version. Value is mandatory.
• IntegrationSubType: string
  Title: Integration Subtype

  Maximum Length: 30

  The integration subtype.
• IntegrationType: string
  Title: Integration Type

  Maximum Length: 30

  The integration type. Value is mandatory.
• IntEnabledFlag: boolean
  Title: Integration Enabled

  Maximum Length: 1

  Default Value: false

  Indicates whether the integration is enabled.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Parameter: string
  Title: Integration Parameter

  Maximum Length: 240

  A parameter for the integration setup.
• ResEndPoint: string
  Title: Integration Endpoint

  Maximum Length: 50

  The rest end point.

{
    "type":"object",
    "properties":{
        "ResEndPoint":{
            "title":"Integration Endpoint",
            "maxLength":50,
            "type":"string",
            "description":"The rest end point.",
            "nullable":true,
            "x-queryable":true
        },
        "IcsIntegrationVersion":{
            "title":"Integration Version",
            "maxLength":10,
            "type":"string",
            "description":"The Oracle Integration Cloud Service integration version. Value is mandatory.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency associated with the integration setup. Value is mandatory.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "IntEnabledFlag":{
            "title":"Integration Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the integration is enabled.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "IcsIntegrationName":{
            "title":"Integration Name",
            "maxLength":50,
            "type":"string",
            "description":"The Oracle Integration Cloud Service integration name. Value is mandatory.",
            "nullable":false,
            "x-queryable":true
        },
        "Parameter":{
            "title":"Integration Parameter",
            "maxLength":240,
            "type":"string",
            "description":"A parameter for the integration setup.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IntegrationSubType":{
            "title":"Integration Subtype",
            "maxLength":30,
            "type":"string",
            "description":"The integration subtype.",
            "nullable":true,
            "x-queryable":true
        },
        "IntegrationType":{
            "title":"Integration Type",
            "maxLength":30,
            "type":"string",
            "description":"The integration type. Value is mandatory.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top