Jump to

• Request
• Response

Update a designer layout

patch

/fscmRestApi/resources/11.13.18.05/publicSectorConfiguratorLayouts/{LayoutId}

Request

Supported Media Types

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

Path Parameters

• LayoutId: integer
  The unique identifier for a designer layout.

Body ()

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

Root Schema : publicSectorConfiguratorLayouts-item

Type: object

Show Source

• ApplicationEndPoint(optional): string
  Maximum Length: 1000

  The name of the record type, which is a blend of the product name and the record type code.
• ApplicationType(optional): string
  Maximum Length: 20

  The name of the product, such as LNP.
• LayoutId(optional): integer(int64)
  The unique identifier for a designer layout.
• LayoutLabel(optional): string
  Maximum Length: 50

  The label describing a designer layout.
• links(optional): array Items
  Title: Items

  Link Relations
• PscCfgrLayoutTypes(optional): array Designer Layout Types
  Title: Designer Layout Types

  The designer layout types resource stores different layout types for specific record types. A record could be a permit or license. A layout type can be either a draft layout or a published layout. This resource is primarily intended to be used by internal Oracle development teams.

{
    "properties":{
        "ApplicationEndPoint":{
            "maxLength":1000,
            "type":"string",
            "description":"The name of the record type, which is a blend of the product name and the record type code."
        },
        "ApplicationType":{
            "maxLength":20,
            "type":"string",
            "description":"The name of the product, such as LNP."
        },
        "LayoutId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a designer layout."
        },
        "LayoutLabel":{
            "maxLength":50,
            "type":"string",
            "description":"The label describing a designer layout."
        },
        "PscCfgrLayoutTypes":{
            "items":{
                "$ref":"#/definitions/publicSectorConfiguratorLayouts-PscCfgrLayoutTypes-item"
            },
            "type":"array",
            "description":"The designer layout types resource stores different layout types for specific record types. A record could be a permit or license. A layout type can be either a draft layout or a published layout. This resource is primarily intended to be used by internal Oracle development teams.",
            "title":"Designer Layout Types"
        },
        "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 : Designer Layout Types

Type: array

Title: Designer Layout Types

The designer layout types resource stores different layout types for specific record types. A record could be a permit or license. A layout type can be either a draft layout or a published layout. This resource is primarily intended to be used by internal Oracle development teams.

Show Source

• Array of: object publicSectorConfiguratorLayouts-PscCfgrLayoutTypes-item

{
    "items":{
        "$ref":"#/definitions/publicSectorConfiguratorLayouts-PscCfgrLayoutTypes-item"
    },
    "type":"array",
    "description":"The designer layout types resource stores different layout types for specific record types. A record could be a permit or license. A layout type can be either a draft layout or a published layout. This resource is primarily intended to be used by internal Oracle development teams.",
    "title":"Designer Layout Types"
}

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"
}

Nested Schema : publicSectorConfiguratorLayouts-PscCfgrLayoutTypes-item

Type: object

Show Source

• ApplicationEndPoint(optional): string
  Maximum Length: 1000

  The name of the specific layout, which is a blend of the product name and the record type code.
• ApplicationType(optional): string
  Maximum Length: 20

  Name of the product, such as LNP.
• ExportLayout(optional): string
  A blob that contains layout configuration metadata, such as the layout payload.
• LayoutId(optional): integer(int64)
  The unique ID of the parent table for the layout.
• LayoutMetadata(optional): string
  A blob that contains layout configuration metadata, such as the layout description, properties, and so on.
• LayoutMetadataSb(optional): string
  The version of the sandbox for the metadata.
• LayoutType(optional): string
  Maximum Length: 20

  It is a version of the layout, draft or published.
• LayoutView(optional): string
  The view object that stores the structure of the designer layout.
• LayoutViewSb(optional): string
  The version of the sandbox for the layout view.
• links(optional): array Items
  Title: Items

  Link Relations
• PublishedState(optional): string
  Maximum Length: 1

  The state of a sandbox. A sandbox can be in a state either of draft or a state of published.
• SandboxSrno(optional): number
  The serial number of the current sandbox, starting from zero then becomes incremented by one after each publish. The sandbox ID does not get reused.
• SandboxUuid(optional): string
  Maximum Length: 64

  The unique identifier for a sandbox.

{
    "properties":{
        "ApplicationEndPoint":{
            "maxLength":1000,
            "type":"string",
            "description":"The name of the specific layout, which is a blend of the product name and the record type code."
        },
        "ApplicationType":{
            "maxLength":20,
            "type":"string",
            "description":"Name of the product, such as LNP."
        },
        "ExportLayout":{
            "type":"string",
            "description":"A blob that contains layout configuration metadata, such as the layout payload."
        },
        "LayoutId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique ID of the parent table for the layout."
        },
        "LayoutMetadata":{
            "type":"string",
            "description":"A blob that contains layout configuration metadata, such as the layout description, properties, and so on."
        },
        "LayoutMetadataSb":{
            "type":"string",
            "description":"The version of the sandbox for the metadata."
        },
        "LayoutType":{
            "maxLength":20,
            "type":"string",
            "description":"It is a version of the layout, draft or published."
        },
        "LayoutView":{
            "type":"string",
            "description":"The view object that stores the structure of the designer layout."
        },
        "LayoutViewSb":{
            "type":"string",
            "description":"The version of the sandbox for the layout view."
        },
        "PublishedState":{
            "maxLength":1,
            "type":"string",
            "description":"The state of a sandbox. A sandbox can be in a state either of draft or a state of published."
        },
        "SandboxSrno":{
            "type":"number",
            "description":"The serial number of the current sandbox, starting from zero then becomes incremented by one after each publish. The sandbox ID does not get reused."
        },
        "SandboxUuid":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier for a sandbox."
        },
        "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"
}

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 : publicSectorConfiguratorLayouts-item

Type: object

Show Source

• ApplicationEndPoint(optional): string
  Maximum Length: 1000

  The name of the record type, which is a blend of the product name and the record type code.
• ApplicationType(optional): string
  Maximum Length: 20

  The name of the product, such as LNP.
• LayoutId(optional): integer(int64)
  The unique identifier for a designer layout.
• LayoutLabel(optional): string
  Maximum Length: 50

  The label describing a designer layout.
• links(optional): array Items
  Title: Items

  Link Relations
• PscCfgrLayoutTypes(optional): array Designer Layout Types
  Title: Designer Layout Types

  The designer layout types resource stores different layout types for specific record types. A record could be a permit or license. A layout type can be either a draft layout or a published layout. This resource is primarily intended to be used by internal Oracle development teams.

{
    "properties":{
        "ApplicationEndPoint":{
            "maxLength":1000,
            "type":"string",
            "description":"The name of the record type, which is a blend of the product name and the record type code."
        },
        "ApplicationType":{
            "maxLength":20,
            "type":"string",
            "description":"The name of the product, such as LNP."
        },
        "LayoutId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a designer layout."
        },
        "LayoutLabel":{
            "maxLength":50,
            "type":"string",
            "description":"The label describing a designer layout."
        },
        "PscCfgrLayoutTypes":{
            "items":{
                "$ref":"#/definitions/publicSectorConfiguratorLayouts-PscCfgrLayoutTypes-item"
            },
            "type":"array",
            "description":"The designer layout types resource stores different layout types for specific record types. A record could be a permit or license. A layout type can be either a draft layout or a published layout. This resource is primarily intended to be used by internal Oracle development teams.",
            "title":"Designer Layout Types"
        },
        "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 : Designer Layout Types

Type: array

Title: Designer Layout Types

The designer layout types resource stores different layout types for specific record types. A record could be a permit or license. A layout type can be either a draft layout or a published layout. This resource is primarily intended to be used by internal Oracle development teams.

Show Source

• Array of: object publicSectorConfiguratorLayouts-PscCfgrLayoutTypes-item

{
    "items":{
        "$ref":"#/definitions/publicSectorConfiguratorLayouts-PscCfgrLayoutTypes-item"
    },
    "type":"array",
    "description":"The designer layout types resource stores different layout types for specific record types. A record could be a permit or license. A layout type can be either a draft layout or a published layout. This resource is primarily intended to be used by internal Oracle development teams.",
    "title":"Designer Layout Types"
}

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"
}

Nested Schema : publicSectorConfiguratorLayouts-PscCfgrLayoutTypes-item

Type: object

Show Source

• ApplicationEndPoint(optional): string
  Maximum Length: 1000

  The name of the specific layout, which is a blend of the product name and the record type code.
• ApplicationType(optional): string
  Maximum Length: 20

  Name of the product, such as LNP.
• ExportLayout(optional): string
  A blob that contains layout configuration metadata, such as the layout payload.
• LayoutId(optional): integer(int64)
  The unique ID of the parent table for the layout.
• LayoutMetadata(optional): string
  A blob that contains layout configuration metadata, such as the layout description, properties, and so on.
• LayoutMetadataSb(optional): string
  The version of the sandbox for the metadata.
• LayoutType(optional): string
  Maximum Length: 20

  It is a version of the layout, draft or published.
• LayoutView(optional): string
  The view object that stores the structure of the designer layout.
• LayoutViewSb(optional): string
  The version of the sandbox for the layout view.
• links(optional): array Items
  Title: Items

  Link Relations
• PublishedState(optional): string
  Maximum Length: 1

  The state of a sandbox. A sandbox can be in a state either of draft or a state of published.
• SandboxSrno(optional): number
  The serial number of the current sandbox, starting from zero then becomes incremented by one after each publish. The sandbox ID does not get reused.
• SandboxUuid(optional): string
  Maximum Length: 64

  The unique identifier for a sandbox.

{
    "properties":{
        "ApplicationEndPoint":{
            "maxLength":1000,
            "type":"string",
            "description":"The name of the specific layout, which is a blend of the product name and the record type code."
        },
        "ApplicationType":{
            "maxLength":20,
            "type":"string",
            "description":"Name of the product, such as LNP."
        },
        "ExportLayout":{
            "type":"string",
            "description":"A blob that contains layout configuration metadata, such as the layout payload."
        },
        "LayoutId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique ID of the parent table for the layout."
        },
        "LayoutMetadata":{
            "type":"string",
            "description":"A blob that contains layout configuration metadata, such as the layout description, properties, and so on."
        },
        "LayoutMetadataSb":{
            "type":"string",
            "description":"The version of the sandbox for the metadata."
        },
        "LayoutType":{
            "maxLength":20,
            "type":"string",
            "description":"It is a version of the layout, draft or published."
        },
        "LayoutView":{
            "type":"string",
            "description":"The view object that stores the structure of the designer layout."
        },
        "LayoutViewSb":{
            "type":"string",
            "description":"The version of the sandbox for the layout view."
        },
        "PublishedState":{
            "maxLength":1,
            "type":"string",
            "description":"The state of a sandbox. A sandbox can be in a state either of draft or a state of published."
        },
        "SandboxSrno":{
            "type":"number",
            "description":"The serial number of the current sandbox, starting from zero then becomes incremented by one after each publish. The sandbox ID does not get reused."
        },
        "SandboxUuid":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier for a sandbox."
        },
        "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"
}

Back to Top