Jump to

• Request
• Response

Create a set of global custom records

post

/fscmRestApi/resources/11.13.18.05/publicSectorCeIntakeGlobalFields/{IntakeKey}/child/CeGlobalCustom

Request

Path Parameters

• IntakeKey(required): integer(int64)
  The key from the intake record.

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 ()

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

Root Schema : schema

Type: object

Show Source

• CreatedBy: string
  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  The date and time that the row was created.
• IntakeId: string
  Maximum Length: 50

  A logical ID for the intake transaction.
• IntakeKey: integer (int64)
  The key from the intake record.
• LastUpdateDate: string (date-time)
  The date and time that the row was updated.
• LastUpdatedBy: string
  Maximum Length: 64

  The user who last updated the row.
• LastUpdateLogin: string
  Maximum Length: 32

  The login who last updated the row.
• ObjectVersionNumber: integer (int32)
  Indicates the object versionnumber.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the row was created.",
            "format":"date-time",
            "nullable":false
        },
        "IntakeKey":{
            "type":"integer",
            "description":"The key from the intake record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Indicates the object versionnumber.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "IntakeId":{
            "maxLength":50,
            "type":"string",
            "description":"A logical ID for the intake transaction.",
            "nullable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time that the row was updated.",
            "format":"date-time",
            "nullable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login who last updated the row.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : publicSectorCeIntakeGlobalFields-CeGlobalCustom-item-response

Type: object

Show Source

• CreatedBy: string
  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  The date and time that the row was created.
• IntakeId: string
  Maximum Length: 50

  A logical ID for the intake transaction.
• IntakeKey: integer (int64)
  The key from the intake record.
• LastUpdateDate: string (date-time)
  The date and time that the row was updated.
• LastUpdatedBy: string
  Maximum Length: 64

  The user who last updated the row.
• LastUpdateLogin: string
  Maximum Length: 32

  The login who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Indicates the object versionnumber.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the row was created.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "IntakeKey":{
            "type":"integer",
            "description":"The key from the intake record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Indicates the object versionnumber.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "IntakeId":{
            "maxLength":50,
            "type":"string",
            "description":"A logical ID for the intake transaction.",
            "nullable":false,
            "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 that the row was updated.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login who last updated the row.",
            "nullable":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