Jump to

• Request
• Response

Create a set of job function configurations

post

/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncConfigurations

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

• DeletedFlag: string
  Maximum Length: 1

  Indicates whether the job configuration row 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.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates that the job configuration row is available to be used.
• JobFuncId: string
  Title: Job Function ID

  Maximum Length: 50

  The identifier of the job function.
• JobFuncSecId: string
  Title: Job Attribute ID

  Maximum Length: 50

  The identifier of the job attribute.
• SeedDataLock: integer (int32)
  Indicates whether the row is seed data. Valid values are 0 for customer data, 1 for seed data that cannot be modified, and 2 or more for seed data that can be modified.
• SeedDataSource: string
  Maximum Length: 512

  The source of the seed data record. A value of "BULK_SEED_DATA_SCRIPT" indicates that the record was from bulk upload. The name of the seed data file is mentioned if no value is shown.

{
    "type":"object",
    "properties":{
        "JobFuncSecId":{
            "title":"Job Attribute ID",
            "maxLength":"50",
            "type":"string",
            "description":"The identifier of the job attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"input_text_lov"
            }
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"The source of the seed data record. A value of \"BULK_SEED_DATA_SCRIPT\" indicates that the record was from bulk upload. The name of the seed data file is mentioned if no value is shown.",
            "nullable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates whether the row is seed data. Valid values are 0 for customer data, 1 for seed data that cannot be modified, and 2 or more for seed data that can be modified.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            }
        },
        "JobFuncId":{
            "title":"Job Function ID",
            "maxLength":"50",
            "type":"string",
            "description":"The identifier of the job function.",
            "nullable":false,
            "x-hints":{
                "controlType":"input_text_lov"
            }
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the job configuration row 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":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the job configuration row is available to be used.",
            "nullable":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 : publicSectorJobFuncConfigurations-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Indicates whether the job configuration row 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.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates that the job configuration row is available to be used.
• JobFuncId: string
  Title: Job Function ID

  Maximum Length: 50

  The identifier of the job function.
• JobFuncSecId: string
  Title: Job Attribute ID

  Maximum Length: 50

  The identifier of the job attribute.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SeedDataLock: integer (int32)
  Indicates whether the row is seed data. Valid values are 0 for customer data, 1 for seed data that cannot be modified, and 2 or more for seed data that can be modified.
• SeedDataSource: string
  Maximum Length: 512

  The source of the seed data record. A value of "BULK_SEED_DATA_SCRIPT" indicates that the record was from bulk upload. The name of the seed data file is mentioned if no value is shown.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFuncSecId":{
            "title":"Job Attribute ID",
            "maxLength":"50",
            "type":"string",
            "description":"The identifier of the job attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"input_text_lov"
            },
            "x-queryable":true
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"The source of the seed data record. A value of \"BULK_SEED_DATA_SCRIPT\" indicates that the record was from bulk upload. The name of the seed data file is mentioned if no value is shown.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates whether the row is seed data. Valid values are 0 for customer data, 1 for seed data that cannot be modified, and 2 or more for seed data that can be modified.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "JobFuncId":{
            "title":"Job Function ID",
            "maxLength":"50",
            "type":"string",
            "description":"The identifier of the job function.",
            "nullable":false,
            "x-hints":{
                "controlType":"input_text_lov"
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the job configuration row 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":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the job configuration row is available to be used.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "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