Jump to

• Request
• Response

Update a web application

patch

/fscmRestApi/resources/11.13.18.05/publicSectorHostNodeDefinitions/{HostName}

Request

Supported Media Types

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

Path Parameters

• HostName: string
  The unique identifier of the web application.

Body ()

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

Root Schema : publicSectorHostNodeDefinitions-item

Type: object

Show Source

• ContextUri(optional): string
  The URL for the starting page (or entry point) of the web application. The value is optional.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates whether the record is logically deleted (true or false). Valid values are true for a deleted record, and false for an active record. The default value is false.
• Description(optional): string
  Maximum Length: 100

  The full description of the web application.
• HostName(optional): string
  Maximum Length: 30

  The unique identifier of the web application.
• IsActive(optional): string
  Maximum Length: 1

  Indicates whether the web application is active (Y or N). Valid values are Y for active, and N for inactive.
• IsLocal(optional): string
  Maximum Length: 1

  Indicates whether the web application hosts only pages delivered by the Public Sector Compliance and Regulation service (Y or N). Valid values are Y to indicate the web application hosts pages delivered by the Public Sector Compliance and Regulation service, and N to indicate the web application hosts pages not delivered by the Public Sector Compliance and Regulation service.
• Label(optional): string
  Maximum Length: 30

  The short description of the web application.
• links(optional): array Items
  Title: Items

  Link Relations
• SeedDataLock(optional): integer(int32)
  Indicates whether a row of data is delivered seed data or not. Valid values are 0 for customer data, 1 for delivered seed data that can't be modified, and 2 for delivered seed data that can be modified. The default value is 0.

{
    "properties":{
        "ContextUri":{
            "type":"string",
            "description":"The URL for the starting page (or entry point) of the web application. The value is optional."
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the record is logically deleted (true or false). Valid values are true for a deleted record, and false for an active record. The default value is false."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The full description of the web application."
        },
        "HostName":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the web application."
        },
        "IsActive":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the web application is active (Y or N). Valid values are Y for active, and N for inactive."
        },
        "IsLocal":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the web application hosts only pages delivered by the Public Sector Compliance and Regulation service (Y or N). Valid values are Y to indicate the web application hosts pages delivered by the Public Sector Compliance and Regulation service, and N to indicate the web application hosts pages not delivered by the Public Sector Compliance and Regulation service."
        },
        "Label":{
            "maxLength":30,
            "type":"string",
            "description":"The short description of the web application."
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates whether a row of data is delivered seed data or not. Valid values are 0 for customer data, 1 for delivered seed data that can't be modified, and 2 for delivered seed data that can be modified. The default value is 0."
        },
        "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 : publicSectorHostNodeDefinitions-item

Type: object

Show Source

• ContextUri(optional): string
  The URL for the starting page (or entry point) of the web application. The value is optional.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates whether the record is logically deleted (true or false). Valid values are true for a deleted record, and false for an active record. The default value is false.
• Description(optional): string
  Maximum Length: 100

  The full description of the web application.
• HostName(optional): string
  Maximum Length: 30

  The unique identifier of the web application.
• IsActive(optional): string
  Maximum Length: 1

  Indicates whether the web application is active (Y or N). Valid values are Y for active, and N for inactive.
• IsLocal(optional): string
  Maximum Length: 1

  Indicates whether the web application hosts only pages delivered by the Public Sector Compliance and Regulation service (Y or N). Valid values are Y to indicate the web application hosts pages delivered by the Public Sector Compliance and Regulation service, and N to indicate the web application hosts pages not delivered by the Public Sector Compliance and Regulation service.
• Label(optional): string
  Maximum Length: 30

  The short description of the web application.
• links(optional): array Items
  Title: Items

  Link Relations
• SeedDataLock(optional): integer(int32)
  Indicates whether a row of data is delivered seed data or not. Valid values are 0 for customer data, 1 for delivered seed data that can't be modified, and 2 for delivered seed data that can be modified. The default value is 0.

{
    "properties":{
        "ContextUri":{
            "type":"string",
            "description":"The URL for the starting page (or entry point) of the web application. The value is optional."
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the record is logically deleted (true or false). Valid values are true for a deleted record, and false for an active record. The default value is false."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The full description of the web application."
        },
        "HostName":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the web application."
        },
        "IsActive":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the web application is active (Y or N). Valid values are Y for active, and N for inactive."
        },
        "IsLocal":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the web application hosts only pages delivered by the Public Sector Compliance and Regulation service (Y or N). Valid values are Y to indicate the web application hosts pages delivered by the Public Sector Compliance and Regulation service, and N to indicate the web application hosts pages not delivered by the Public Sector Compliance and Regulation service."
        },
        "Label":{
            "maxLength":30,
            "type":"string",
            "description":"The short description of the web application."
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates whether a row of data is delivered seed data or not. Valid values are 0 for customer data, 1 for delivered seed data that can't be modified, and 2 for delivered seed data that can be modified. The default value is 0."
        },
        "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