Jump to

• Request
• Response

Create a catalog resource

post

/fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}/child/Catalogs

Request

Path Parameters

• ResourceId(required): string
  The unique identifier for the resource.

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

• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the record is logically deleted (Y or N). Valid values are Y for a deleted record, and N for an active record. The default value is N.
• IsOfflineSupportRequired: string
  Maximum Length: 1

  Indicates if offline support is required.
• IsSearchEnabled: string
  Maximum Length: 1

  Indicates if search is enabled.
• ModuleId: string
  Maximum Length: 32

  The value is used by Seed Data Framework and indicates the module that owns the row. A module is an entry in Application Taxonomy such as a Logical Business Area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.
• ObjectVersionNumber: integer (int32)
  The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PromptEnabled: string
  Maximum Length: 1

  Indicates if this REST resource is prompt-enabled.
• Querysource: string
  Maximum Length: 1

  Indicates if the resource ID can be used as a primary or a related object in a custom query.
• Reportable: string
  Maximum Length: 1

  Indicates if a resource ID can be used in reporting tools as a data source.
• ResourceId: string
  Maximum Length: 50

  The unique identifier for a resource.
• ResourceName: string
  Maximum Length: 256

  The unique resource name to identify a resource.
• RestEndPoint: string
  Maximum Length: 1000

  The REST end point.
• SeedDataLock: integer (int32)
  Default Value: 1

  The number used to indicate whether the row is delivered seed data or customer data. Valid values are 0 for data that is customer data, 1 for delivered seed data that can't be modified, and 2 indicates that the seed data can be modified.
• Version: string
  Maximum Length: 20

  The REST version number.

{
    "type":"object",
    "properties":{
        "PromptEnabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if this REST resource is prompt-enabled.",
            "nullable":true
        },
        "ResourceName":{
            "maxLength":"256",
            "type":"string",
            "description":"The unique resource name to identify a resource.",
            "nullable":false
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"The number used to indicate whether the row is delivered seed data or customer data. Valid values are 0 for data that is customer data, 1 for delivered seed data that can't be modified, and 2 indicates that the seed data can be modified.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"1"
            }
        },
        "RestEndPoint":{
            "maxLength":"1000",
            "type":"string",
            "description":"The REST end point.",
            "nullable":false
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"The value is used by Seed Data Framework and indicates the module that owns the row. A module is an entry in Application Taxonomy such as a Logical Business Area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.",
            "nullable":true
        },
        "ResourceId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for a resource.",
            "nullable":false
        },
        "Version":{
            "maxLength":"20",
            "type":"string",
            "description":"The REST version number.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "IsOfflineSupportRequired":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if offline support is required.",
            "nullable":false
        },
        "IsSearchEnabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if search is enabled.",
            "nullable":false
        },
        "Querysource":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the resource ID can be used as a primary or a related object in a custom query.",
            "nullable":true
        },
        "Reportable":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if a resource ID can be used in reporting tools as a data source.",
            "nullable":false
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is logically deleted (Y or N). Valid values are Y for a deleted record, and N for an active record. The default value is N.",
            "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 : publicSectorApplicationIdTypes-Catalogs-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date and time the row was created.
• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the record is logically deleted (Y or N). Valid values are Y for a deleted record, and N for an active record. The default value is N.
• IsOfflineSupportRequired: string
  Maximum Length: 1

  Indicates if offline support is required.
• IsSearchEnabled: string
  Maximum Length: 1

  Indicates if search is enabled.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

  The session login associated with the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModuleId: string
  Maximum Length: 32

  The value is used by Seed Data Framework and indicates the module that owns the row. A module is an entry in Application Taxonomy such as a Logical Business Area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.
• ObjectVersionNumber: integer (int32)
  The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PromptEnabled: string
  Maximum Length: 1

  Indicates if this REST resource is prompt-enabled.
• Querysource: string
  Maximum Length: 1

  Indicates if the resource ID can be used as a primary or a related object in a custom query.
• Reportable: string
  Maximum Length: 1

  Indicates if a resource ID can be used in reporting tools as a data source.
• ResourceId: string
  Maximum Length: 50

  The unique identifier for a resource.
• ResourceName: string
  Maximum Length: 256

  The unique resource name to identify a resource.
• RestEndPoint: string
  Maximum Length: 1000

  The REST end point.
• SeedDataLock: integer (int32)
  Default Value: 1

  The number used to indicate whether the row is delivered seed data or customer data. Valid values are 0 for data that is customer data, 1 for delivered seed data that can't be modified, and 2 indicates that the seed data can be modified.
• Version: string
  Maximum Length: 20

  The REST version number.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromptEnabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if this REST resource is prompt-enabled.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":"256",
            "type":"string",
            "description":"The unique resource name to identify a resource.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"The number used to indicate whether the row is delivered seed data or customer data. Valid values are 0 for data that is customer data, 1 for delivered seed data that can't be modified, and 2 indicates that the seed data can be modified.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "RestEndPoint":{
            "maxLength":"1000",
            "type":"string",
            "description":"The REST end point.",
            "nullable":false,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"The value is used by Seed Data Framework and indicates the module that owns the row. A module is an entry in Application Taxonomy such as a Logical Business Area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for a resource.",
            "nullable":false,
            "x-queryable":true
        },
        "Version":{
            "maxLength":"20",
            "type":"string",
            "description":"The REST version number.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "IsOfflineSupportRequired":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if offline support is required.",
            "nullable":false,
            "x-queryable":true
        },
        "IsSearchEnabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if search is enabled.",
            "nullable":false,
            "x-queryable":true
        },
        "Querysource":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the resource ID can be used as a primary or a related object in a custom query.",
            "nullable":true,
            "x-queryable":true
        },
        "Reportable":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if a resource ID can be used in reporting tools as a data source.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is logically deleted (Y or N). Valid values are Y for a deleted record, and N for an active record. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated with the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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