Jump to

• Request
• Response

Create a web application

post

/fscmRestApi/resources/11.13.18.05/publicSectorHostNodeDefinitions

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:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

  Default Value: false

  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: string
  Maximum Length: 100

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

  The unique identifier of the web application.
• IsActive: 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: 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: string
  Maximum Length: 30

  The short description of the web application.
• SeedDataLock: integer (int32)
  Default Value: 0

  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.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":"100",
            "type":"string",
            "description":"The full description of the web application.",
            "nullable":false
        },
        "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.",
            "nullable":false
        },
        "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.",
            "nullable":false,
            "x-queryable":false
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            }
        },
        "Label":{
            "maxLength":"30",
            "type":"string",
            "description":"The short description of the web application.",
            "nullable":false
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "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.",
            "nullable":false,
            "default":false
        },
        "HostName":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the web application.",
            "nullable":false
        },
        "ContextUri":{
            "type":"string",
            "description":"The URL for the starting page (or entry point) of the web application. The value is optional.",
            "nullable":true,
            "x-queryable":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:
  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.

Body ()

Root Schema : publicSectorHostNodeDefinitions-item-response

Type: object

Show Source

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

  Default Value: false

  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: string
  Maximum Length: 100

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

  The unique identifier of the web application.
• IsActive: 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: 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: string
  Maximum Length: 30

  The short description of the web application.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SeedDataLock: integer (int32)
  Default Value: 0

  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.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":"100",
            "type":"string",
            "description":"The full description of the web application.",
            "nullable":false,
            "x-queryable":true
        },
        "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.",
            "nullable":false,
            "x-queryable":true
        },
        "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.",
            "nullable":false,
            "x-queryable":false
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "Label":{
            "maxLength":"30",
            "type":"string",
            "description":"The short description of the web application.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HostName":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the web application.",
            "nullable":false,
            "x-queryable":true
        },
        "ContextUri":{
            "type":"string",
            "description":"The URL for the starting page (or entry point) of the web application. The value is optional.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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