Create an application package
post
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationPackages
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
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The identifier of the public sector agency which belongs to the application package. -
Applicant: integer
(int64)
Indicates the applicant.
-
ApplicationPackageLine: array
Application Package Lines
Title:
Application Package Lines
The application package lines resource is used to store the application specific information. -
AppPackageKey: integer
(int64)
The unique identifier of the application package.
-
AppPackagePuid(required): string
Maximum Length:
480
The unique identifier of the application package transaction record in the legacy system. -
Description: string
Maximum Length:
1000
The long description of the application package. -
GeneralData: string
(byte)
Contains the common data attributes across all the applications.
-
PackageName(required): string
Maximum Length:
100
The short name for the application package. -
PackageStatus: string
Title:
Package Status
Maximum Length:30
The overall status of the application package. -
SubmitDate: string
(date-time)
The user who submitted the package.
-
VersionType: string
Title:
Version Type
Maximum Length:1
The version type of the application package.
Nested Schema : Application Package Lines
Type:
array
Title:
Application Package Lines
The application package lines resource is used to store the application specific information.
Show Source
Nested Schema : publicSectorApplicationPackages-ApplicationPackageLine-item-post-request
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The identifier of the public sector agency which belongs to the application package. -
ApplicationOrder: integer
(int32)
The sequence for each application.
-
ApplicationType: string
Title:
Application Type
Maximum Length:30
The source offering for the package. -
AppPackageKey: integer
(int64)
The unique identifier of the application package.
-
AppPackageLnPuid: string
Maximum Length:
480
The unique identifier of the application package line transaction record in the legacy system. -
DeletedFlag: boolean
Maximum Length:
1
Indicates whether the application should be considered as deleted from the package. -
LayoutVersion: string
Maximum Length:
30
The version of the intake layout. -
RecordType: string
Maximum Length:
100
The displayed name of the record type. -
RecordTypeCode: string
Maximum Length:
20
The code representing the record type. -
RecordTypeId: string
Maximum Length:
30
The unique identifier for the resource used to generate an application. -
SourceRecordId: string
Maximum Length:
50
The record ID of the parent, or origination transaction. -
SourceRecordKey: integer
(int64)
The unique key of the parent, or origination transaction.
-
TransactionId: string
Maximum Length:
50
The meaningful identifier for the linked transaction. -
TransactionKey: integer
(int64)
The unique identifier for the linked transaction.
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.
Root Schema : publicSectorApplicationPackages-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The identifier of the public sector agency which belongs to the application package. -
Applicant: integer
(int64)
Indicates the applicant.
-
ApplicationPackageLine: array
Application Package Lines
Title:
Application Package Lines
The application package lines resource is used to store the application specific information. -
AppPackageKey: integer
(int64)
The unique identifier of the application package.
-
AppPackagePuid: string
Maximum Length:
480
The unique identifier of the application package transaction record in the legacy system. -
Description: string
Maximum Length:
1000
The long description of the application package. -
GeneralData: string
(byte)
Contains the common data attributes across all the applications.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PackageName: string
Maximum Length:
100
The short name for the application package. -
PackageStatus: string
Title:
Package Status
Maximum Length:30
The overall status of the application package. -
SubmitDate: string
(date-time)
The user who submitted the package.
-
VersionType: string
Title:
Version Type
Maximum Length:1
The version type of the application package.
Nested Schema : Application Package Lines
Type:
array
Title:
Application Package Lines
The application package lines resource is used to store the application specific information.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorApplicationPackages-ApplicationPackageLine-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The identifier of the public sector agency which belongs to the application package. -
ApplicationOrder: integer
(int32)
The sequence for each application.
-
ApplicationType: string
Title:
Application Type
Maximum Length:30
The source offering for the package. -
AppPackageKey: integer
(int64)
The unique identifier of the application package.
-
AppPackageLnPuid: string
Maximum Length:
480
The unique identifier of the application package line transaction record in the legacy system. -
DeletedFlag: boolean
Maximum Length:
1
Indicates whether the application should be considered as deleted from the package. -
LayoutVersion: string
Maximum Length:
30
The version of the intake layout. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RecordType: string
Maximum Length:
100
The displayed name of the record type. -
RecordTypeCode: string
Maximum Length:
20
The code representing the record type. -
RecordTypeId: string
Maximum Length:
30
The unique identifier for the resource used to generate an application. -
SourceRecordId: string
Maximum Length:
50
The record ID of the parent, or origination transaction. -
SourceRecordKey: integer
(int64)
The unique key of the parent, or origination transaction.
-
TransactionId: string
Maximum Length:
50
The meaningful identifier for the linked transaction. -
TransactionKey: integer
(int64)
The unique identifier for the linked transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- ApplicationPackageLine
-
Parameters:
- publicSectorApplicationPackagesUniqID:
$request.path.publicSectorApplicationPackagesUniqID
The application package lines resource is used to store the application specific information. - publicSectorApplicationPackagesUniqID: