Skip to content

custom-features-scripts.md

Latest commit

 

History

History
39 lines (23 loc) · 1.2 KB

custom-features-scripts.md

File metadata and controls

39 lines (23 loc) · 1.2 KB

Rules

Here are the main rules to follow in order for custom scripts to run smoothly :

  • the script name must be the feature name
  • the script will be able to take advantage of all input parameters available in the Inputs object (see further)
  • HTTP standard return codes must be managed for all scenario
  • return content should be properly set

When you create a new feature with New-PXFeature, you can specify the -createfile switch so that a script template is generated to help you start writing your API code.

The Inputs object

Inside the Inputs object, you will find :

  • the URL path requested
  • the HTTP method
  • the body (if any)
  • the parameters (if any) passed in the URL. Example: value of the op parameter for the endpoint /addition/{op}

The returned object

Custom features scripts must return the following Powershell Custom Object :

[PSCustomObject]@{
  ReturnCode=<[System.Net.HttpStatusCode]>
  Content=<string>
  ContentType=<content-type>
}

see System.Net.HttpStatusCode

Examples

You will find an example of a custom feature script with the feature called demo-feature.