Jump to

• Request
• Response

Update an integration setup

patch

/fscmRestApi/resources/11.13.18.05/publicSectorIntegrationSetups/{publicSectorIntegrationSetupsUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorIntegrationSetupsUniqID: string
  Identifier to Integration Setups

Body ()

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

Root Schema : publicSectorIntegrationSetups-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

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

  Maximum Length: 50

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

  Maximum Length: 10

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

  Maximum Length: 30

  The integration subtype.
• IntegrationType(optional): string
  Title: Integration Type

  Maximum Length: 30

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

  Indicates whether the integration is enabled.
• links(optional): array Items
  Title: Items

  Link Relations
• Parameter(optional): string
  Title: Integration Parameter

  Maximum Length: 240

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

  Maximum Length: 50

  The rest end point.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency associated with the integration setup. Value is mandatory.",
            "title":"Agency ID"
        },
        "IcsIntegrationName":{
            "maxLength":50,
            "type":"string",
            "description":"The Oracle Integration Cloud Service integration name. Value is mandatory.",
            "title":"Integration Name"
        },
        "IcsIntegrationVersion":{
            "maxLength":10,
            "type":"string",
            "description":"The Oracle Integration Cloud Service integration version. Value is mandatory.",
            "title":"Integration Version"
        },
        "IntEnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the integration is enabled.",
            "title":"Integration Enabled"
        },
        "IntegrationSubType":{
            "maxLength":30,
            "type":"string",
            "description":"The integration subtype.",
            "title":"Integration Subtype"
        },
        "IntegrationType":{
            "maxLength":30,
            "type":"string",
            "description":"The integration type. Value is mandatory.",
            "title":"Integration Type"
        },
        "Parameter":{
            "maxLength":240,
            "type":"string",
            "description":"A parameter for the integration setup.",
            "title":"Integration Parameter"
        },
        "ResEndPoint":{
            "maxLength":50,
            "type":"string",
            "description":"The rest end point.",
            "title":"Integration Endpoint"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorIntegrationSetups-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

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

  Maximum Length: 50

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

  Maximum Length: 10

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

  Maximum Length: 30

  The integration subtype.
• IntegrationType(optional): string
  Title: Integration Type

  Maximum Length: 30

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

  Indicates whether the integration is enabled.
• links(optional): array Items
  Title: Items

  Link Relations
• Parameter(optional): string
  Title: Integration Parameter

  Maximum Length: 240

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

  Maximum Length: 50

  The rest end point.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency associated with the integration setup. Value is mandatory.",
            "title":"Agency ID"
        },
        "IcsIntegrationName":{
            "maxLength":50,
            "type":"string",
            "description":"The Oracle Integration Cloud Service integration name. Value is mandatory.",
            "title":"Integration Name"
        },
        "IcsIntegrationVersion":{
            "maxLength":10,
            "type":"string",
            "description":"The Oracle Integration Cloud Service integration version. Value is mandatory.",
            "title":"Integration Version"
        },
        "IntEnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the integration is enabled.",
            "title":"Integration Enabled"
        },
        "IntegrationSubType":{
            "maxLength":30,
            "type":"string",
            "description":"The integration subtype.",
            "title":"Integration Subtype"
        },
        "IntegrationType":{
            "maxLength":30,
            "type":"string",
            "description":"The integration type. Value is mandatory.",
            "title":"Integration Type"
        },
        "Parameter":{
            "maxLength":240,
            "type":"string",
            "description":"A parameter for the integration setup.",
            "title":"Integration Parameter"
        },
        "ResEndPoint":{
            "maxLength":50,
            "type":"string",
            "description":"The rest end point.",
            "title":"Integration Endpoint"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top