Jump to

• Request
• Response

Create a safe domain

post

/fscmRestApi/resources/11.13.18.05/publicSectorSafeDomains

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the agency.
• AllowImageLink: string
  Title: Image

  Maximum Length: 1

  Default Value: N

  Indicates the image allowed for the safe domain.
• AllowLink: string
  Title: Link

  Maximum Length: 1

  Default Value: N

  Indicates the link allowed for the safe domain.
• DomainName: string
  Title: Domain Name

  Maximum Length: 255

  The name of a domain added in the safe domains list.
• EnabledFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates that the safe domain is enabled.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "AllowImageLink":{
            "title":"Image",
            "maxLength":1,
            "type":"string",
            "description":"Indicates the image allowed for the safe domain.",
            "nullable":false,
            "default":"N"
        },
        "AllowLink":{
            "title":"Link",
            "maxLength":1,
            "type":"string",
            "description":"Indicates the link allowed for the safe domain.",
            "nullable":false,
            "default":"N"
        },
        "DomainName":{
            "title":"Domain Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of a domain added in the safe domains list.",
            "nullable":false
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the safe domain is enabled.",
            "nullable":false,
            "default":"N"
        }
    }
}

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 : publicSectorSafeDomains-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the agency.
• AllowImageLink: string
  Title: Image

  Maximum Length: 1

  Default Value: N

  Indicates the image allowed for the safe domain.
• AllowLink: string
  Title: Link

  Maximum Length: 1

  Default Value: N

  Indicates the link allowed for the safe domain.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who created the safe domain.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the safe domain was created.
• DomainName: string
  Title: Domain Name

  Maximum Length: 255

  The name of a domain added in the safe domains list.
• EnabledFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates that the safe domain is enabled.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the safe domain was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who updated the row last.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Unique identifier of the last update.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The unique identifier of the object version number.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "AllowImageLink":{
            "title":"Image",
            "maxLength":1,
            "type":"string",
            "description":"Indicates the image allowed for the safe domain.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "AllowLink":{
            "title":"Link",
            "maxLength":1,
            "type":"string",
            "description":"Indicates the link allowed for the safe domain.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the safe domain.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the safe domain was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DomainName":{
            "title":"Domain Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of a domain added in the safe domains list.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the safe domain is enabled.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the safe domain was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier of the last update.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who updated the row last.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The unique identifier of the object version number.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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